Schedules V2

View and manage schedules. Manage your full schedule of on-call rotations, including the users and rotation configuration.

ListScheduleEntries Schedules V2

Get a list of schedule entries. The endpoint will return all entries that overlap with the given window, if one is provided.

Request
query Parameters
schedule_id
required
string

The ID of the schedule to get entries for.

Example: schedule_id=01FDAG4SAP5TYPT98WGR2N7W91
entry_window_start
string <date-time>

The start of the window to get entries for.

Example: entry_window_start=2021-01-01T00:00:00Z
entry_window_end
string <date-time>

The end of the window to get entries for.

Example: entry_window_end=2021-01-01T00:00:00Z
Responses
200

OK response.

get/v2/schedule_entries
Request samples 
Response samples 
application/json
{
  • "pagination_meta": {
    },
  • "schedule_entries": {
    }
}
CreateOverride Schedules V2
Create a new schedule override.


Request 
Request Body schema: application/json
required
end_at
required
string <date-time> 
End time of the override


 
layer_id
required
string
The layer this override applies to


 
rotation_id
required
string
The rotation this override applies to


 
schedule_id
required
string
The schedule this override applies to


 
start_at
required
string <date-time> 
Start time of the override


 
required
object (UserReferencePayloadV2) 
 
Responses 
201
Created response.


post/v2/schedule_overrides
Request samples 
application/json
{
  • "end_at": "2021-08-17T14:00:00.000000Z",
  • "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH",
  • "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
  • "schedule_id": "01G0J1EXE7AXZ2C93K61WBPYEH",
  • "start_at": "2021-08-17T13:00:00.000000Z",
  • "user": {
    }
}
Response samples 
application/json
{
  • "override": {
    }
}
List Schedules V2
List configured schedules.


Request 
query Parameters
page_size
integer <int64> 
 Default:  25
number of records to return


 
 Example:  page_size=25
after
string
A schedule's ID. This endpoint will return a list of schedules after this ID in relation to the API response order.


 
 Example:  after=01FDAG4SAP5TYPT98WGR2N7W91
Responses 
200
OK response.


get/v2/schedules
Request samples 
Response samples 
application/json
{
  • "pagination_meta": {
    },
  • "schedules": [
    ]
}
Create Schedules V2
Create a new schedule.


Request 
Request Body schema: application/json
required
required
object (ScheduleCreatePayloadV2) 
 
Responses 
201
Created response.


post/v2/schedules
Request samples 
application/json
{
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "schedule": {
    }
}
Destroy Schedules V2
Archives a single schedule.


Request 
path Parameters
id
required
string
Unique internal ID of the schedule


 
 Example:  01G0J1EXE7AXZ2C93K61WBPYEH
Responses 
202
Accepted response.


delete/v2/schedules/{id}
Request samples 
Show Schedules V2
Get a single schedule.


Request 
path Parameters
id
required
string
Unique internal ID of the schedule


 
 Example:  01G0J1EXE7AXZ2C93K61WBPYEH
Responses 
200
OK response.


get/v2/schedules/{id}
Request samples 
Response samples 
application/json
{
  • "schedule": {
    }
}
Update Schedules V2
Update a schedule.


Request 
path Parameters
id
required
string
The schedule ID to update.


 
 Example:  01G0J1EXE7AXZ2C93K61WBPYEH
Request Body schema: application/json
required
required
object (ScheduleUpdatePayloadV2) 
 
Responses 
200
OK response.


put/v2/schedules/{id}
Request samples 
application/json
{
  • "schedule": {
    }
}
Response samples 
application/json
{
  • "schedule": {
    }
}
➔ Next to Severities V1