Tenants

Get a List of Tenants

GET

Query parameters

parent_tenant_idstringOptional

Filter the list of tenants by parent_id

limitintegerOptional
The number of tenants to return (defaults to 20, maximum value of 100)
cursorstringOptional
Continue the pagination with the next cursor

Response

This endpoint returns an object
has_more
boolean
Set to true when there are more pages that can be retrieved.
items
list of objects
An array of Tenants
url
string
A url that may be used to generate these results.
type
"list"
Always set to "list". Represents the type of this object.
cursor
stringOptional

A pointer to the next page of results. Defined only when has_more is set to true.

next_url
stringOptional

A url that may be used to generate fetch the next set of results. Defined only when has_more is set to true