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_moreboolean

Set to true when there are more pages that can be retrieved.

itemslist of objects

An array of Tenants

urlstring

A url that may be used to generate these results.

type"list"Defaults to list

Always set to “list”. Represents the type of this object.

cursorstringOptional

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

next_urlstringOptional

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

Built with