Skip to main content
GET
List tenants

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Query Parameters

root_tenant_id
string<uuid>

List this tenant and the tenants beneath it. Defaults to your own tenant. Must be your own tenant or one beneath it.

Matches tenants whose name, short name or host contains this text, ignoring case.

kind
string

Only tenants of this kind: organization | customer | tenant.

status
string

Only tenants in this state: active | provisioning | suspended | disabled | deleted. When omitted, every state is included, deleted tenants too.

page

The page to return, starting at 1 (the default).

page_size

Tenants per page: 1–100, default 50.

Response

OK

One page of tenants, ordered by name. Request the next page with page set to next_page; the last page has next_page null.

items
object[]
required

The tenants on this page. Empty when nothing matches the filters.

page
required

The page number returned, starting at 1.

page_size
required

The maximum number of tenants per page, as requested (default 50, maximum 100).

total_count
required

The number of tenants that match the filters across all pages.

next_page

The page to request next. Null when this is the last page.