Skip to main content
POST
Query points by identifier
Send up to 200 point identifiers per request. For more points, split them across requests and merge the results.

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

Return only points in this area.

canonicalType
string

Return only points whose device has this canonical type.

q
string

Search text.

asc
string

Field to sort by in ascending order.

dsc
string
default:_id

Field to sort by in descending order.

Body

application/json
pointIds
string[]
required
max 200

Point identifiers to return.

Maximum array length: 200
Example:

Response

A page of matching points.

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