Get tenant status

Returns the current aggregated status of a tenant including health status and verification details.
The status is computed from the health of all credentials and subscriptions under the tenant.

Use the include parameter to request additional details:

  • subscriptions - Include status for each subscription under the tenant
  • credentials - Include detailed status (health, cooldown, usage metrics) for each credential

Multiple values can be combined with commas: include=subscriptions,credentials

Path Params
uuid
required

The unique tenant identifier.

Query Params
string

Comma-separated list of additional data to include (subscriptions, credentials).

Responses

500

Internal server error.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json