Skip to main content
GET
List schedule points
Each item names a point, its device, and its area, with the schedule slot the point follows and the point’s current value in curVal. type is DIRECT for a point linked to the schedule itself, or INDIRECT for a point that follows it through another link. A non-empty invalidReason means the link is broken and the schedule does not drive that point. A page past the last page returns an empty page, and itemCount is 0. A schedule that does not exist, or that belongs to a different building, returns 404.
The q parameter is ignored on this endpoint.

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.

scheduleId
string
required

ID of Schedule

Query Parameters

asc
string

Sort ascending by one of pointName, deviceName, type, or slot.

dsc
string
default:_id

Sort descending by one of pointName, deviceName, type, or slot. The default order is newest first.

limit
integer<int32>
default:50

Maximum number of points to return, 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
q
string

Not used. This endpoint ignores q.

Response

A page of point references.

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