Skip to main content
GET
List tenants

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

q
string

Keeps tenants whose name or external_ref contains this text.

status
enum<string>

Send active to leave out offboarded tenants.

Available options:
active
page
integer

The page number, from 1.

Required range: x >= 1

Response

Success