Skip to main content
GET
Get a schedule
Use the id from List schedules. A schedule that does not exist, or that belongs to a different building, returns 404.

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

Response

The schedule.

id
string
name
string
displayName
string
type
enum<string>
Available options:
WEEKLY,
CALENDAR
origin
enum<string>
Available options:
DISCOVERY,
KODEOS
kind
string
curVal
string
nextVal
string
nextTime
string
defaultVal
string
connector
object
level
object
minVal
number<double>
maxVal
number<double>
unit
string
effectivePeriod
object
weekDays
object
events
object[]