Skip to main content
GET
List buildings
Call this endpoint first to confirm that your token works and to get the buildingId values used by other endpoints.

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.

Headers

accept-language
string

Locale for the response.

Query Parameters

page
integer
default:1

Page number to return. The first page is 1.

Required range: x >= 1
limit
integer
default:50

Maximum number of items per page.

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

Return only the building with this identifier.

Response

A page of buildings.

itemCount
integer

Total number of matching items.

Example:

1

limit
integer

Maximum number of items per page.

Example:

50

page
integer

Current page number.

Example:

1

pageCount
integer

Total number of pages.

Example:

1

data
Building · object[]