> ## 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 schedule points

> Returns the points a schedule drives, and whether each link to the schedule is valid.

Each item names a point, its device, and its area, with the schedule `slot` the point follows and the point's current value in `curVal`. `type` is `DIRECT` for a point linked to the schedule itself, or `INDIRECT` for a point that follows it through another link. A non-empty `invalidReason` means the link is broken and the schedule does not drive that point.

A page past the last page returns an empty page, and `itemCount` is `0`.

A schedule that does not exist, or that belongs to a different building, returns `404`.

> [!NOTE]
>
> The `q` parameter is ignored on this endpoint.


## OpenAPI

````yaml /openapi/kode-api.yaml get /api/v1/buildings/{buildingId}/schedules/{scheduleId}/points
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}/points:
    get:
      tags:
        - Schedules
      summary: List schedule points
      description: >-
        Returns the points a schedule drives, and whether each link to the
        schedule is valid.
      operationId: listSchedulePoints
      parameters:
        - $ref: '#/components/parameters/BuildingId'
        - description: ID of Schedule
          name: scheduleId
          in: path
          required: true
          schema:
            type: string
        - name: asc
          in: query
          schema:
            type: string
          description: >-
            Sort ascending by one of `pointName`, `deviceName`, `type`, or
            `slot`.
        - name: dsc
          in: query
          schema:
            type: string
            default: _id
          description: >-
            Sort descending by one of `pointName`, `deviceName`, `type`, or
            `slot`. The default order is newest first.
        - name: limit
          in: query
          schema:
            type: integer
            format: int32
            maximum: 200
            minimum: 1
            default: 50
          description: >-
            Maximum number of points to return, from `1` to `200`. The default
            is `50`.
        - 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`.
      responses:
        '200':
          description: A page of point references.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEntitySchedulePointRefPublic'
        '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.
        '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:
    PaginatedEntitySchedulePointRefPublic:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SchedulePointRefPublic'
        page:
          type: integer
          format: int32
        limit:
          type: integer
          format: int32
        pageCount:
          type: integer
          format: int32
        itemCount:
          type: integer
          format: int32
    SchedulePointRefPublic:
      type: object
      properties:
        point:
          $ref: '#/components/schemas/PointRecord'
        type:
          $ref: '#/components/schemas/Type5'
        slot:
          type: string
        invalidReason:
          type: string
        curVal:
          type: string
    PointRecord:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        device:
          $ref: '#/components/schemas/Ref2'
        area:
          $ref: '#/components/schemas/Ref2'
    Type5:
      type: string
      enum:
        - DIRECT
        - INDIRECT
    Ref2:
      type: object
      properties:
        id:
          type: string
        name:
          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.