Search Tenant

LLM-friendly URL

POST

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

API call form

Examples

List of examples

Get a tenant by identifier
Get a tenant and its assigned columns and formulas

Description

Retrieve a tenant together with the columns and formulas assigned to it.

Install

npm install @luzmo/nodejs-sdk

Example Request

Shell

Node

Java

.NET

Python

PHP

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('tenant',
  {
    where: {
      id: "<tenant_id>"
    },
    include: [
      {
        model: "Column",
        attributes: [
          "id",
          "name",
          "securable_id"
        ]
      },
      {
        model: "Formula",
        attributes: [
          "id",
          "name"
        ]
      }
    ]
  }
);

Example Response

200

400

500

{
  "count": 1,
  "rows": [
    {
      "id": "508eb8ae-24f6-4f6e-a0cc-c050258af89e",
      "identifier": "suborg",
      "name": {
        "en": "Suborg"
      },
      "created_at": "2026-09-29T10:55:02.237Z",
      "updated_at": "2026-09-29T10:55:10.387Z",
      "organization_id": "25344a26-7bf4-4707-9d07-e6cd07319dca",
      "columns": [
        {
          "id": "1d66382d-ac07-439e-98bd-62799ed1c14f",
          "name": {
            "en": "salsa_level"
          },
          "securable_id": "f2f9c24b-bb17-4886-ba77-c5ee9dbc14e7",
          "columnTenant": {
            "column_id": "1d66382d-ac07-439e-98bd-62799ed1c14f",
            "tenant_id": "508eb8ae-24f6-4f6e-a0cc-c050258af89e"
          }
        }
      ],
      "formulas": [
        {
          "id": "45333d1a-aae6-4d2f-bb2e-07520db41fdd",
          "name": {
            "en": "Total burritos savoured"
          },
          "formulaTenant": {
            "formula_id": "45333d1a-aae6-4d2f-bb2e-07520db41fdd",
            "tenant_id": "508eb8ae-24f6-4f6e-a0cc-c050258af89e"
          }
        }
      ]
    }
  ]
}