Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
TenantService
Tenants

Get a tenant by ID

Retrieves a tenant by its canonical id or by the external_id:<value> form the customer asserted it under.

get/v1/workspaces/{workspaceId}/tenants/{id}

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q

Workspace ID.

idstring required

Tenant ID. Accepts the canonical tenant_… form or the external_id:<value> form.

Query parameters

includeInfoboolean

When true, the info field is populated.

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_ACTIVE' | 'STATE_ERASING' enum required

The current lifecycle state of the tenant. Output only.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  }
}