> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. 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](https://docs.kodelabs.com/products/kode-api/api-reference/schedules/list-schedule-points.md). > [!NOTE] > > The `q` and `fields` parameters are ignored on this endpoint. ## OpenAPI ````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/schedules openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/buildings/{buildingId}/schedules: get: tags: - Schedules summary: List schedules description: >- 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. operationId: listBuildingSchedules parameters: - $ref: '#/components/parameters/BuildingId' - name: asc in: query schema: type: string description: >- Sort ascending by one of `name`, `displayName`, `type`, `origin`, or `kind`. - name: dsc in: query schema: type: string default: _id description: >- Sort descending by one of `name`, `displayName`, `type`, `origin`, or `kind`. The default order is newest first. - description: >- `true` returns only hidden schedules. The default is `false`, which returns only visible schedules. name: hidden in: query schema: type: string pattern: true|false default: 'false' - description: >- Return only schedules of this kind. One of `CalendarSchedule`, `BooleanSchedule`, `NumericSchedule`, `EnumSchedule`, or `StringSchedule`. The value is case-sensitive. name: kind in: query schema: type: string pattern: >- CalendarSchedule|BooleanSchedule|NumericSchedule|EnumSchedule|StringSchedule - description: >- 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`. name: levelId in: query schema: type: string - name: limit in: query schema: type: integer format: int32 maximum: 200 minimum: 1 default: 50 description: >- Maximum number of schedules to return, from `1` to `200`. The default is `50`. - description: >- Return only schedules of this origin. One of `DISCOVERY` or `KODEOS`. The value is case-sensitive. name: origin in: query schema: type: string pattern: DISCOVERY|KODEOS - name: page in: query schema: type: integer format: int32 minimum: 1 default: 1 description: Page number to return. The first page is `1`. - name: q in: query schema: type: string description: Not used. This endpoint ignores `q`. - description: >- Return only schedules of this type. One of `WEEKLY` or `CALENDAR`. The value is case-sensitive. name: type in: query schema: type: string pattern: WEEKLY|CALENDAR responses: '200': description: A page of schedules. content: application/json: schema: $ref: '#/components/schemas/PaginatedEntitySchedulePublic' '400': description: >- A query parameter is not valid. The `fields` list in the error names each parameter and the reason. '401': $ref: '#/components/responses/Unauthorized' '403': description: >- The service account lacks permission to view schedules, or the building does not exist or is not assigned to it. KODE API answers `403` in both cases so that building ids cannot be probed. '429': $ref: '#/components/responses/TooManyRequests' components: parameters: BuildingId: name: buildingId in: path required: true description: Building identifier from List buildings. schema: type: string example: 67c960faffaa42223163099e schemas: PaginatedEntitySchedulePublic: type: object properties: data: type: array items: $ref: '#/components/schemas/SchedulePublic' page: type: integer format: int32 limit: type: integer format: int32 pageCount: type: integer format: int32 itemCount: type: integer format: int32 SchedulePublic: type: object properties: id: type: string name: type: string displayName: type: string type: $ref: '#/components/schemas/Type6' origin: $ref: '#/components/schemas/Origin' kind: type: string curVal: type: string nextVal: type: string nextTime: type: string defaultVal: type: string connector: $ref: '#/components/schemas/Ref3' level: $ref: '#/components/schemas/Ref3' minVal: type: number format: double maxVal: type: number format: double unit: type: string effectivePeriod: $ref: '#/components/schemas/Period' weekDays: $ref: '#/components/schemas/WeekDays' events: type: array items: $ref: '#/components/schemas/Event' Type6: type: string enum: - WEEKLY - CALENDAR Origin: type: string enum: - DISCOVERY - KODEOS Ref3: type: object properties: id: type: string name: type: string Period: type: object properties: start: $ref: '#/components/schemas/Day' end: $ref: '#/components/schemas/Day' WeekDays: type: object properties: monday: type: array items: $ref: '#/components/schemas/Slot' tuesday: type: array items: $ref: '#/components/schemas/Slot' wednesday: type: array items: $ref: '#/components/schemas/Slot' thursday: type: array items: $ref: '#/components/schemas/Slot' friday: type: array items: $ref: '#/components/schemas/Slot' saturday: type: array items: $ref: '#/components/schemas/Slot' sunday: type: array items: $ref: '#/components/schemas/Slot' Event: type: object properties: name: type: string type: type: string day: type: integer format: int32 month: type: integer format: int32 year: type: integer format: int32 weekday: type: integer format: int32 week: type: integer format: int32 start: $ref: '#/components/schemas/Day' end: $ref: '#/components/schemas/Day' reference: type: string timeValues: type: array items: $ref: '#/components/schemas/Slot' Day: type: object properties: day: type: integer format: int32 month: type: integer format: int32 year: type: integer format: int32 Slot: type: object properties: start: type: string end: type: string value: type: string responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.