Skip to main content
API Explorer|API Explorer
Alerting & Response/On-Call
GETOnCallSince 1.0SynchronousAuth Required

ListOnCallSchedules

List all on-call schedules available in the system

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    List of schedules returned by this query

    Example: (nested array)

    • uuidString

      Unique identifier of the schedule

      Example: sched-00112233

    • nameString

      Human-readable name of the schedule

      Example: Platform On-Call

    • descriptionString

      Brief description of the schedule purpose

      Example: 24x7 platform on-call rotation

    • timezoneString

      IANA timezone name for the schedule

      Example: Asia/Shanghai

    • rotationTypeString

      Rotation type: daily, weekly, or custom

      Example: weekly

    • shiftDurationString

      Duration of each shift as a Go duration string

      Example: 168h

    • membersList

      Ordered list of members participating in the rotation

      Example: (nested array)

      • userIdString

        User identifier of the on-call member

        Example: user-abc123

      • userNameString

        Display name of the on-call member

        Example: Alice Smith

      • orderInteger

        Rotation order position of the member within the schedule

        Example: 1

    • startDateString

      Timestamp when the schedule rotation begins

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

    • createDateString

      Timestamp when the schedule was created

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

    • lastOpDateString

      Timestamp of the last modification to the schedule

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

  • totalInteger

    Total number of schedules matching the query

    Example: 10

  • limitInteger

    Maximum number of items per page

    Example: 20

  • offsetInteger

    Number of items skipped before this page

    Example: 20

Endpoint

GET/api/v1/oncall/schedules

/api/v1/oncall/schedules

Operation ID

ListOnCallSchedules

Permalink

Request Example

curl -X GET '{host}/api/v1/oncall/schedules' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 10,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history