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

ListOnCallSchedules

List all on-call schedules available in the system

GET/api/v1/oncall/schedules

Operation ID

ListOnCallSchedules

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

This API requires no request parameters.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    List of schedules returned by this query

    Example: (nested array)

    • 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

  • total
    Integer

    Total number of schedules matching the query

    Example: 10

  • limit
    Integer

    Maximum number of items per page

    Example: 20

  • offset
    Integer

    Number of items skipped before this page

    Example: 20