Get tenant

GET /tenant/{id}

Path Parameters

idstring

required·

The tenant id, percent-encoded as a single path segment. Tenant ids are free-form and may contain /, spaces or non-ASCII, so reserved characters have to be escaped: acme/prod is requested as /tenant/acme%2Fprod. Sent raw, it is two path segments, matches no route, and comes back 404. Only unreserved escapes are normalised before the request reaches the API, so %2F arrives intact and is decoded back to the original id.

Example: acme-corp

Query Parameters

environment_idstring · uuid

Required for session auth. Ignored (and inferred from the token) for API tokens.

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

Response Body

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 and immutable once created. Composite primary key with environment_id, so the same value can exist independently in development, staging, and production. Free-form up to 255 characters: whatever you already use to identify a customer, including /, spaces and non-ASCII. The only values rejected are the ones no URL path segment can carry — control characters, leading or trailing whitespace, and the dot segments . and ...

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/{id}' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.truto.one/tenant/{id}', {
  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/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
}

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