> ## 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. # Get a schedule > Returns one schedule of a building, with its current value, next change, and weekly or calendar definition. Use the `id` from [List schedules](https://docs.kodelabs.com/products/kode-api/api-reference/schedules/list-schedules.md). A schedule that does not exist, or that belongs to a different building, returns `404`. ## OpenAPI ````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/schedules/{scheduleId} 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/{scheduleId}: get: tags: - Schedules summary: Get a schedule description: >- Returns one schedule of a building, with its current value, next change, and weekly or calendar definition. operationId: getBuildingSchedule parameters: - $ref: '#/components/parameters/BuildingId' - description: ID of Schedule name: scheduleId in: path required: true schema: type: string responses: '200': description: The schedule. content: application/json: schema: $ref: '#/components/schemas/SchedulePublic' '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. '404': description: The schedule does not exist in this building. '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: 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.