Skip to main content
GET
List spaces
Use the filters to narrow the list. A space must match every filter you send. A filter value that matches nothing returns an empty page, not an error. category must be one of the listed values, in the exact letter case. q searches the space name. The match is not case-sensitive and can start anywhere in the name. An empty q returns every space.

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.

category
enum<string>

Return only spaces of this category.

Available options:
Level,
SpaceUnit,
Zone
dsc
string
default:_id

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

identifier
string

Return only the space with this identifier.

leasable
string

Return only spaces where leasable is true, or only spaces where it is false.

limit
integer<int32>
default:50

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

Required range: 1 <= x <= 200
operationalStatus
string

Return only spaces with this operational status.

page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
parentSpaceId
string

Return only spaces inside this level or space.

q
string

Search text. Matches the space name.

tenantUnit
string

Return only spaces where tenantUnit is true, or only spaces where it is false.

type
string

Return only spaces of this type.

usage
string

Return only spaces with this usage.

Response

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

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