Schedules

Schedules arrange the eligible members of the team into fair and balanced on-call shifts. The API allows you to retrieve existing schedules.

List schedules

GET /schedules

List all schedules in the organization.

Headers

Name	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer <your API key>`

Parameters

Name	Type	Description
`name_eq`	string	Filter by the name of the schedule.

Response

{
  "page": 1,
  "per_page": 25,
  "has_more": true,
  "total_pages": 1,
  "total_count": 6,
  "results": [
    {
      "id": "sch_01j1t4hnbbexn82vfpxjrc6zg5",
      "name": "<Team name> schedule",
      "created_at": "2024-07-02T16:30:48.684Z",
      "updated_at": "2024-07-11T19:10:52.067Z",
      "description": "Optional description for this schedule",
      "enabled": true,
      "backstop": {
        "id": "orguser_01j1t4hn98eyzt6nmz943138v9",
        "name": "Backstop Name",
        "email": "backstop@acme.corp"
      }
    }
  ]
}

{
  "error": "Invalid request"
}

List all on-calls

GET /schedules/<schedule ID>/oncalls

This method returns the list of all on-calls within the time range, and their contact information.

Headers

Name	Value
Content-Type	`application/json`
Authorization	`Bearer <your API key>`

Body

Name	Type	Description
`time_range[start]`	iso8601 datetime	Starting time range to inspect.
`time_range[end]`	iso8601 datetime	Ending time range to inspect.

Response

The response includes a stage attribute that determines which stage the person is at in the schedule. If the person has a Slack account, the response includes the slack_user_id with a contact_methods type of slack.

{
  "has_more": false,
  "oncalls": [
    {
      "schedule_id": "sch_01jbyaj382ex9v727zzxer0wgw",
      "stage": 0.0,
      "start_time": "2024-11-04T09:00:00.000Z",
      "end_time": "2024-11-11T09:00:00.000Z",
      "user": {
        "name": "Katherine Jakubowski [Demo]",
        "email": "katherine.jakubowski@example.com",
        "contact_methods": [
          {
            "type": "phone",
            "value": "(705) 777-7777"
          }
        ]
      }
    }
  ]
}

{
  "error": "Invalid request"
}

List schedules​

List all on-calls​

List schedules

List all on-calls