Skip to main content
GET
Get one tenant and its sub-tenants from the authorized partner scope.

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token, carrying subject_type=machine_client and the pulse.read scope.

Scopes

pulse.read

Path Parameters

tenantId
string<uuid>
required

The tenant: a tenant_id from List tenants. It must be inside the caller's authorized scope.

Response

The tenant and every tenant beneath it.

The tenants the caller is authorized for, as a flat list ordered by position in the hierarchy.

root_tenant_id
string<uuid>
required

The top of the caller's authorized scope.

items
object[]
required

The tenants. Use parent_tenant_id and depth to rebuild the hierarchy.