List schedules
Returns the schedules of a building, newest first by default. Filter by type, origin, kind, or level. Each schedule includes its current value and its weekly or calendar definition.
DISCOVERY for schedules read from the building system, and KODEOS for schedules created in KODE OS. This endpoint is read-only. You cannot create, edit, or delete schedules through the KODE API.
Hidden schedules are left out unless you send hidden=true. With hidden=true, the response holds only the hidden schedules, not both groups.
Weekly schedules (type is WEEKLY) return a weekDays object with the slots for each day, and, at the schedule level, minVal, maxVal, unit and effectivePeriod when they are set. Calendar schedules (type is CALENDAR) return events with the special days and none of the weekly members. level is the building level the schedule belongs to. To list the points a schedule drives, call List schedule points.
q and fields parameters are ignored on this endpoint.Authorizations
Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.
Path Parameters
Building identifier from List buildings.
Query Parameters
Sort ascending by one of name, displayName, type, origin, or kind.
Sort descending by one of name, displayName, type, origin, or kind. The default order is newest first.
true returns only hidden schedules. The default is false, which returns only visible schedules.
true|falseReturn only schedules of this kind. One of CalendarSchedule, BooleanSchedule, NumericSchedule, EnumSchedule, or StringSchedule. The value is case-sensitive.
CalendarSchedule|BooleanSchedule|NumericSchedule|EnumSchedule|StringScheduleReturn only schedules on this level, the level.id of a schedule. A level id that matches no schedule returns an empty page. The value other is reserved and returns 400.
Maximum number of schedules to return, from 1 to 200. The default is 50.
1 <= x <= 200Return only schedules of this origin. One of DISCOVERY or KODEOS. The value is case-sensitive.
DISCOVERY|KODEOSPage number to return. The first page is 1.
x >= 1Not used. This endpoint ignores q.
Return only schedules of this type. One of WEEKLY or CALENDAR. The value is case-sensitive.
WEEKLY|CALENDAR
