Skip to main content
ZStack
Alerting & Response/On-Call

GetOnCallSchedule

Get details of a specific on-call schedule by UUID

GET/api/v1/oncall/schedules/{uuid}

Operation ID

GetOnCallSchedule

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • uuid
    StringRequired

    UUID of the schedule to retrieve

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • uuid
    String

    Unique identifier of the schedule

    Example: sched-00112233

  • name
    String

    Human-readable name of the schedule

    Example: Platform On-Call

  • description
    String

    Brief description of the schedule purpose

    Example: 24x7 platform on-call rotation

  • timezone
    String

    IANA timezone name for the schedule

    Example: Asia/Shanghai

  • rotationType
    String

    Rotation type: daily, weekly, or custom

    Example: weekly

  • shiftDuration
    String

    Duration of each shift as a Go duration string

    Example: 168h

  • members
    List

    Ordered list of members participating in the rotation

    Example: (nested array)

    • userId
      String

      User identifier of the on-call member

      Example: user-abc123

    • userName
      String

      Display name of the on-call member

      Example: Alice Smith

    • order
      Integer

      Rotation order position of the member within the schedule

      Example: 1

  • startDate
    String

    Timestamp when the schedule rotation begins

    Example: 2026-01-15T08:00:00Z

  • createDate
    String

    Timestamp when the schedule was created

    Example: 2026-01-15T08:00:00Z

  • lastOpDate
    String

    Timestamp of the last modification to the schedule

    Example: 2026-01-15T08:00:00Z