Schedules

Schedules arrange the eligible members of the team into fair and balanced on-call shifts. Currently the API does not allow creating or managing schedules.

List schedules

GET /schedules

List all schedules in the organization.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Parameters

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

Response

200

{
  "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": "[e-mail]"
      }
    },
  ]
}

400

{
  "error": "Invalid request"
}

List all on-calls

GET /schedules/$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 <token>

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 will include a stage attribute, which determines which stage the person is in the schedule. If the person has a Slack account, the response will include the slack_user_id. with a contact_methods type of slack.

200

{
  "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": "[e-mail]",
        "contact_methods": [
          {
            "type": "phone",
            "value": "[phone]"
          }
        ]
      }
    }
  ]
}

400

{
  "error": "Invalid request"
}