List all tenants

GET

/v1/admin/tenants

Returns paginated list of all tenants. Useful for admin dashboards and tenant discovery.

Authorizations

AdminKeyAuth

Administrative API key with full system access

Type

API Key (header: X-Admin-API-Key)

Parameters

Query Parameters

status

Type

string

Valid values

"ACTIVE""SUSPENDED""CLOSED"

parent_tenant_id

Type

string

cursor

Type

string

limit

Type

integer

Minimum

1

Maximum

100

Default

50

Responses

Tenant list

Content-Type

application/json

{

  

"tenants": [

  

  

{

  

  

  

"tenant_id": "string",

  

  

  

"name": "string",

  

  

  

"status": "string",

  

  

  

"parent_tenant_id": "string",

  

  

  

"default_commit_overage_policy": "string",

  

  

  

"default_reservation_ttl_ms": 60000,

  

  

  

"max_reservation_ttl_ms": 3600000,

  

  

  

"max_reservation_extensions": 10,

  

  

  

"reservation_expiry_policy": "AUTO_RELEASE",

  

  

  

"metadata": {

  

  

  

  

"additionalProperties": "string"

  

  

  

},

  

  

  

"created_at": "string",

  

  

  

"updated_at": "string",

  

  

  

"suspended_at": "string",

  

  

  

"closed_at": "string"

  

  

}

  

],

  

"next_cursor": "string",

  

"has_more": true

}

GET

/v1/admin/tenants

Playground

Authorization

AdminKeyAuth

Variables

Key

Value

status

parent_tenant_id

cursor

limit

Samples

Powered by VitePress OpenAPI