Get a tenant.

GET

/api/admin/tenants/{id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/tenants/example \
  --header 'Authorization: Bearer <token>'

Get a tenant by path ID. The path parameter identifies the target tenant, so X-Tenant-Id is not required.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Responses

200

Tenant inventory detail response.

Media type application/json

Tenant inventory row returned by list and detail endpoints, including provisioning metadata derived from the tenant D1 pool when that mode is enabled.

object

id

required

string

tenant_code

required

string

name

required

string

description

required

string | null

lifecycle_state

required

string

Allowed values: provisioning active suspended frozen migration_read_only deleting deleted restore_pending restore_validating

is_default

required

boolean

created_at

required

Unix timestamp in seconds.

integer format: int64

updated_at

required

Unix timestamp in seconds.

integer format: int64

provisioning_status

required

string

Allowed values: active inactive provisioning_failed

provisioning_error

required

string | null

provisioning_slot_id

required

string | null

provisioning_updated_at

required

Unix timestamp in seconds when provisioning metadata was last updated.

integer | null format: int64

key

additional properties

Example

{
  "id": "acme",
  "tenant_code": "acme",
  "name": "Acme Corp",
  "description": "Production tenant for Acme Corp.",
  "lifecycle_state": "active",
  "is_default": false,
  "created_at": 1770000000,
  "updated_at": 1770000000,
  "provisioning_status": "active",
  "provisioning_error": null,
  "provisioning_slot_id": null,
  "provisioning_updated_at": null
}