Skip to main content
GET
List schedules
A schedule is a time-based plan that drives the value of points, such as a weekly occupancy plan or a holiday calendar. Schedules come from two origins: 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.
The q and fields parameters are 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.

Query Parameters

asc
string

Sort ascending by one of name, displayName, type, origin, or kind.

dsc
string
default:_id

Sort descending by one of name, displayName, type, origin, or kind. The default order is newest first.

hidden
string
default:false

true returns only hidden schedules. The default is false, which returns only visible schedules.

Pattern: true|false
kind
string

Return only schedules of this kind. One of CalendarSchedule, BooleanSchedule, NumericSchedule, EnumSchedule, or StringSchedule. The value is case-sensitive.

Pattern: CalendarSchedule|BooleanSchedule|NumericSchedule|EnumSchedule|StringSchedule
levelId
string

Return 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.

limit
integer<int32>
default:50

Maximum number of schedules to return, from 1 to 200. The default is 50.

Required range: 1 <= x <= 200
origin
string

Return only schedules of this origin. One of DISCOVERY or KODEOS. The value is case-sensitive.

Pattern: DISCOVERY|KODEOS
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.

type
string

Return only schedules of this type. One of WEEKLY or CALENDAR. The value is case-sensitive.

Pattern: WEEKLY|CALENDAR

Response

A page of schedules.

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