Search TenantDatasetSource

LLM-friendly URL

POST

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

API call form

Examples

A tenant dataset source links a tenant and a base dataset to a connection and a table ( source_sheet ) or SQL query ( source_query ). When an embed token of that tenant queries the base dataset, Luzmo queries the tenant's table or query instead of the base dataset's own source. Callers without a tenant keep querying the base dataset's source.

The tenant's table or query must contain every shared field of the base dataset: each column that has a source_name , is not a derived column, and is not assigned to a tenant. A shared field matches a column of the tenant's table or query when source_name , type and source_type are all equal. The tenant's table or query can contain additional columns: these are the tenant's own fields.

Tenant field discovery

When an embed token of the tenant retrieves the base dataset with a Column include, the response also contains the additional columns of the tenant's table or query. These are discovered fields: they are not saved yet. A where , limit or offset on the Column include leaves them out.
A discovered field has a deterministic id : the same tenant, dataset and source column always give the same id.
Search Column does not return a discovered field, and updating or deleting it returns 404 .
A discovered field is saved the first time the tenant uses it in a data query, or references it in the expression of a derived column or formula. Luzmo then saves it as a column of the base dataset, with the same id , assigned to the tenant. Referencing it in an expression requires use rights on the dataset through the token's rights .
A saved column behaves like any other tenant field. Changing it requires modify through the token's tenant_fields_rights (see Create Authorization ).

Queries on a tenant dataset source don't use the base dataset's acceleration . They always run on the tenant's table or query.

Only main-organization users can create, retrieve, update or delete tenant dataset sources. For other callers, such as embed tokens of a tenant, these requests fail with 403 .

Retrieve tenant dataset sources. You only get tenant dataset sources of tenants in your organization, on datasets you can read.

Request parameters

Response schema

Can be executed by:

Organization Member (main organization)

Dataset Reader

Can be associated to:

Tenant

Securable

Account

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.get('tenantdatasetsource',
  {
    where: {
      securable_id: "<dataset_id>"
    }
  }
);

Example Response

200

400

500

{
  "count": 2,
  "rows": [
    {
      "id": "deea1671-0a97-4d3f-935a-1cbe7f1921a8",
      "source_sheet": "public.burritos_suborg",
      "source_query": null,
      "created_at": "2026-09-29T11:08:09.661Z",
      "updated_at": "2026-09-29T11:08:09.661Z",
      "tenant_id": "508eb8ae-24f6-4f6e-a0cc-c050258af89e",
      "securable_id": "f2f9c24b-bb17-4886-ba77-c5ee9dbc14e7",
      "account_id": "99dc1808-bfd9-49f7-b448-e611e6e10a13",
      "acceleration_id": null
    },
    {
      "id": "76ad933b-e964-474b-8e08-a9d237d8ae8d",
      "source_sheet": null,
      "source_query": "SELECT type_of_burrito, number_burritos_savoured, salsa_level FROM public.burritos_suborg2",
      "created_at": "2026-09-29T11:08:09.691Z",
      "updated_at": "2026-09-29T11:08:09.691Z",
      "tenant_id": "bd932f0c-05ed-4cf7-bdfa-5809314298f4",
      "securable_id": "f2f9c24b-bb17-4886-ba77-c5ee9dbc14e7",
      "account_id": "99dc1808-bfd9-49f7-b448-e611e6e10a13",
      "acceleration_id": null
    }
  ]
}