Get a List of Tenants

Lists the workspace's tenants, each carrying a name, parent tenant, properties, and default preferences. Paged.

get/tenants

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/tenants/get.ts
A function with typed inputs. Its response is checked against the schema.

parent_tenant_idstring nullable

Filter the list of tenants by parent_id

limitinteger nullable

The number of tenants to return (defaults to 20, maximum value of 100)

cursorstring nullable

Continue the pagination with the next cursor

cursorstring nullable

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

has_moreboolean required

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

next_urlstring nullable

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

urlstring required

A url that may be used to generate these results.

type'list' required

Always set to "list". Represents the type of this object.

No recorded changes to this operation across all 55 revisions of this API.