Get tenant details

GET

/v1/admin/tenants/{tenant_id}

Returns the full tenant configuration including status, defaults, and metadata.

Authorizations

AdminKeyAuth

Administrative API key with full system access. Also accepted as an alternative to ApiKeyAuth on an explicit per-operation allowlist — the authoritative list is the union of operations whose security: block declares AdminKeyAuth (consult per-operation security blocks rather than this prose, which has historically drifted as the dual-auth surface expanded). When using AdminKeyAuth on list or fund endpoints, a tenant scoping parameter (typically tenant or tenant_id) is required for scoping (400 if missing) — the per-operation description specifies which. Lookup-style endpoints that uniquely identify a resource by non-tenant key (e.g. GET /v1/admin/budgets/lookup, where the (scope, unit) pair is unique) do NOT require a tenant parameter. Allowlisting is per-operation (exact method:path matching — no prefix matching, no wildcards) so new endpoints do not accidentally inherit admin-accessible status.

Type

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

Parameters

Path Parameters

tenant_id*

Type

string

Required

Responses

Tenant details

Content-Type

application/json

{

  

"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"

}

GET

/v1/admin/tenants/{tenant_id}

Playground

Authorization

AdminKeyAuth

Variables

Key

Value

tenant_id*

Samples

Powered by VitePress OpenAPI