Create Tenant

LLM-friendly URL

POST

https://api.luzmo.com/0.1.0/tenant

A tenant represents one of your customers within your organization. Its identifier is the value you set as tenant (or suborganization ) when you create an embed token for a user of that customer.

Tenants scope tenant-specific fields:

A column or formula without tenant assignments is a shared field. Every caller with access to the dataset can see it.
A column or formula assigned to one or more tenants is a tenant field. Embed tokens of those tenants can see it; embed tokens of other tenants cannot.
Callers without a tenant see every field. These are API tokens of main-organization users and embed tokens created with suborganization and tenant set to null .

Tenant visibility decides which fields a caller can see. The access rights on the dataset decide what the caller can do with the fields it sees. See Custom fields per tenant for a full setup.

Only main-organization users can manage tenants. A main-organization user is a user of your own Luzmo organization, as opposed to an embed user of one of your customers: an organization member who is not in a suborganization.

Create a tenant. The tenant is added to the organization of the caller.

identifier is required, between 1 and 255 characters, and unique within your organization. It cannot be changed after creation.
name defaults to {"en": "<identifier>"} .

You don't need to create tenants up front. Creating an embed token with a suborganization (or tenant ) that has no tenant yet creates the tenant with that identifier. Create a tenant explicitly when you want to set up its tenant dataset sources or field assignments before its first embed token.

Creating a tenant does not create a suborganization group. See the suborganization property of Create Authorization for when the group is created.

Validation errors:

No identifier : A tenant identifier is required.
An empty identifier , or one longer than 255 characters: Must be non-empty and at most 255 characters long.
An identifier that already exists in your organization: Must be unique (value already in use). , reported under the organization_id key of validation .

Request parameters

Response schema

Expand all

Reset

Can be executed by:

Organization Member (main organization)

Can be associated to:

Organization

Columns

Formulas

Did this page help you?

Yes

Language

Shell

Node

Java

.NET

Python

PHP

Install

npm install @luzmo/nodejs-sdk

Example Request

import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('tenant',
  {
    identifier: "< a suborganization name >",
    name: {
      en: "< tenant name >"
    }
  }
);

Example Response

200

400

500

{
  "id": "508eb8ae-24f6-4f6e-a0cc-c050258af89e",
  "identifier": "suborg",
  "name": {
    "en": "Suborg"
  },
  "organization_id": "25344a26-7bf4-4707-9d07-e6cd07319dca",
  "updated_at": "2026-09-29T10:55:02.237Z",
  "created_at": "2026-09-29T10:55:02.237Z"
}