Skip to main content
GET
Get a tenant

Authorizations

X-API-Key
string
header
required

Path Parameters

tenancy_id
string
required

Response

Successful Response

One tenant: the record that anchors a credential and its rate budget.

A tenant is the thing your credentials belong to — a vendor account discovered from the credentials themselves (a Five9 Domain, for example), or a tenant you named yourself when the platform has nothing to discover. N credentials against the same tenant share ONE rate budget.

Each rate bucket reports the provider's raw caps per time window, the operator's margin_pct safety margin, and the effective budget computed from both. min_interval_ms is the minimum spacing enforced between two consecutive calls on the bucket — a floor applied on top of the window budget, so a bucket can be well inside its hourly cap and still be paced; null means no explicit floor. The margin is deliberately NOT applied to it (it multiplies call counts, and shortening a duration would loosen the budget rather than tighten it). is_manual is true for a tenant you named rather than one discovered from a vendor, and such a tenant has no provider-published caps, so its budget is empty. sync_status reports whether the caps are provider-observed (live), catalog defaults (catalog_default), or unchanged after a refresh returned unusable counters (stale).

id
string
required
org_id
string
required
platform_id
string
required
label
string
required
is_manual
boolean
required
status
string
required
buckets
Buckets · object
required
sync_status
string
required
counters_synced_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time> | null
required