Skip to content
GET /tenant

Query Parameters

idstring

Filter by tenant id (supports exact match and admin operators like id[like]=acme%).

Example: acme-corp
namestring

Filter by tenant display name.

Example: Acme Corp
environment_idstring · uuid

Filter by environment. Only applicable to session auth; ignored for API tokens (already scoped to one environment).

Example: 8a2b104d-74a6-47f2-b93e-c6b611e82391
limitinteger

Page size (default 100, max 1000).

Example: 100
next_cursorstring

Cursor from a previous response to fetch the next page.

Response Body

limitnumber
Example: 100
next_cursorstring
Example: MjAyNi0wNy0wMlQwOToxNDowMy4xMTda
resultobject[]
created_atstring · date-time

The date and time when the tenant was created.

Example: 2026-07-02T09:14:03.117Z
environment_idstring · uuid

The environment this tenant belongs to.

Example: 8a2b104d-74a6-47f2-b93e-c6b611e82391
idstring

The tenant identifier — caller-chosen, URL-path-safe, and immutable once created. Composite primary key with environment_id, so the same value can exist independently in development, staging, and production. Must match ^[A-Za-z0-9._:@+-]{1,255}$.

Example: acme-corp
metadataRecord<string, any>

Free-form JSON object stored verbatim. Truto does not interpret this field — use it for tier, region, billing plan, or any other customer attribute your app cares about.

Example: {"tier":"gold","region":"wnam"}
namestring

Display name shown in the dashboard. Defaults to the tenant id on create if not supplied; can be edited later via PATCH /tenant/{id}.

Example: Acme Corp
updated_atstring · date-time

The date and time when the tenant was last updated.

Example: 2026-07-02T09:14:03.117Z
curl -X GET 'https://api.truto.one/tenant' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'
const response = await fetch('https://api.truto.one/tenant', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/tenant"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
}

response = requests.get(url, headers=headers, params=params)
print(response.json())