Skip to main content
GET
List building comments

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

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
asc
string

Field to sort by in ascending order.

dsc
string
default:_id

Field to sort by in descending order.

q
string

Search text.

updatedAtFrom
string<date-time>

Return items updated on or after this time (ISO 8601).

updatedAtTo
string<date-time>

Return items updated on or before this time (ISO 8601).

Response

A page of comments.

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
object[]