Skip to main content
GET
List space assignments
Use the filters to narrow the list. An assignment must match every filter you send. spaceId and tenantId match assignments that include the space or belong to the tenant. Repeat spaceId to match any of several spaces. A filter value that matches nothing returns an empty page. Send dates as YYYY-MM-DD. Each date filter includes the date you send.

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

activeOnly
boolean

Send true to return only active assignments. Any other value returns all assignments.

asc
string

Field to sort by, lowest first.

dsc
string
default:_id

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

endDateFrom
string<date>

Return assignments that end on or after this date (YYYY-MM-DD).

Example:

"2022-03-10"

endDateTo
string<date>

Return assignments that end on or before this date (YYYY-MM-DD).

Example:

"2022-03-10"

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
spaceId
string[]

Return assignments that include this space. Repeat the parameter to match any of several spaces.

startDateFrom
string<date>

Return assignments that start on or after this date (YYYY-MM-DD).

Example:

"2022-03-10"

startDateTo
string<date>

Return assignments that start on or before this date (YYYY-MM-DD).

Example:

"2022-03-10"

tenantId
string

Return only assignments of this tenant.

type
string[]

Return only assignments of this type. The only type is lease. The value is case-sensitive. Repeat the parameter to match any of several values.

Response

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

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