> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sentivel.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get an on-call schedule

> One schedule's config (timezone, participants) plus who is on call right now, the next handoff, and the next few upcoming shifts (rotation handoffs, overrides, and any uncovered gaps).



## OpenAPI

````yaml https://www.sentivel.com/api/v1/openapi.json get /schedules/{id}
openapi: 3.1.0
info:
  title: Sentivel API
  version: 1.0.0
  description: >-
    Provision and read your Sentivel workspace programmatically: components,
    monitors, status pages and incidents. Authenticate with an org API token
    (create one under Developers → API tokens in the dashboard).
  contact:
    name: Sentivel
    url: https://www.sentivel.com
servers:
  - url: https://www.sentivel.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Identity
    description: Who the token is
  - name: Components
    description: Status-page components (status units)
  - name: Monitors
    description: Uptime/HTTP checks
  - name: Status pages
    description: Public status pages
  - name: Incidents
    description: Incidents (read + manual create)
  - name: People
    description: Workspace members
  - name: Integrations
    description: Outbound alert destinations
  - name: On-call
    description: On-call schedules
paths:
  /schedules/{id}:
    get:
      tags:
        - On-call
      summary: Get an on-call schedule
      description: >-
        One schedule's config (timezone, participants) plus who is on call right
        now, the next handoff, and the next few upcoming shifts (rotation
        handoffs, overrides, and any uncovered gaps).
      operationId: getSchedule
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The schedule.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Schedule'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such schedule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Schedule:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        timeZone:
          type: string
        onCall:
          $ref: '#/components/schemas/OnCallNow'
        nextHandoffAt:
          type:
            - string
            - 'null'
          format: date-time
        participants:
          type: array
          items:
            $ref: '#/components/schemas/ScheduleParticipant'
        upcomingShifts:
          type: array
          description: The next few shift segments from now.
          items:
            type: object
            properties:
              userId:
                type:
                  - string
                  - 'null'
                format: uuid
              name:
                type:
                  - string
                  - 'null'
              startsAt:
                type: string
                format: date-time
              endsAt:
                type: string
                format: date-time
              source:
                type: string
                enum:
                  - override
                  - layer
                  - gap
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - unauthorized
                - forbidden
                - not_found
                - invalid_request
                - rate_limited
                - conflict
                - internal
            message:
              type: string
            details:
              type: object
          required:
            - code
            - message
    OnCallNow:
      type:
        - object
        - 'null'
      description: Who is on call right now (null = uncovered gap).
      properties:
        userId:
          type: string
          format: uuid
        name:
          type: string
    ScheduleParticipant:
      type: object
      properties:
        userId:
          type: string
          format: uuid
        name:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'An org API token (`sv_…`), sent as `Authorization: Bearer <token>`.'

````