Auth API reference

Auth API · Consumer-Tenants

get/{app_slug}/v1/tenants/{tenant_id}Auth

Fetch a single tenant by its UUID or `tnt_<12hex>` display id. PAK must hold auth.tenant.read.

Path parameters

app_slug*string

Slug of the app.

tenant_id*string

Id of the tenant.

Response · 200 Tenant.

id*string

Unique identifier of the tenant.

display_id*string

Short, human-friendly id of the tenant (shown in the console).

Example: "tnt_3a9f2b1c0d4e"

app_id*string

The Auth app the tenant belongs to.

slug*string

URL-safe identifier of the tenant, unique within its parent.

Example: "acme-org"

display_name*string

Human-readable name of the tenant.

Example: "Acme Org"

status*object

Tenant status: `active`, `suspended` or `archived`.

metadata*object

Free-form JSON object you attach to the tenant; returned as stored.

created_at*string · date-time

When the tenant was created (ISO 8601).

updated_at*string · date-time

When the tenant was last changed (ISO 8601).

Example

Request

GET https://api.auth.productcraft.co/{app_slug}/v1/tenants/{tenant_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "string",
  "display_id": "tnt_3a9f2b1c0d4e",
  "app_id": "string",
  "slug": "acme-org",
  "display_name": "Acme Org",
  "status": {},
  "metadata": {},
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}