Skip to main content
GET
List tenants
Use status to narrow the list. The value is case-sensitive. Repeat the parameter to match any of several statuses. A value that matches nothing returns an empty page.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Query Parameters

asc
string

Field to sort by, lowest first, for example name.

dsc
string
default:_id

Field to sort by, highest first. Defaults to _id.

limit
integer<int32>
default:50

Number of items per page, from 1 to 200. The default is 50.

Required range: 1 <= x <= 200
page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
status
string[]

Return only tenants with this status, active or inactive. Repeat the parameter to match any of several statuses.

Response

A page of tenants. itemCount is the total number of tenants that match the filters.

data
object[]
page
integer<int32>
limit
integer<int32>
pageCount
integer<int32>
itemCount
integer<int32>