On-call schedules

List shifts

The rotation as laid out in time, oldest first. Without a window this returns what is still ahead — shifts that have not ended yet — because that is the question worth asking; a year of past rotation is rarely wanted and never wanted whole. Handovers are NOT folded in here: a shift row says what the rotation planned, and GET /api/v1/schedules/{schedule}/overrides says what temporarily replaces it. For the resolved answer at one instant use /on-call.

get/api/v1/schedules/{schedule}/shifts

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/schedules/{schedule}/shifts
  • Auth: API key in header X-API-Key

Path parameters

schedulestring uuid required

Schedule UUID.

Query parameters

role'primary' | 'secondary' | 'manager'

Only this slot of the rotation. Omit for all three.

fromstring date-time

Lower bound: shifts ending after this instant. ISO-8601 with an explicit offset. Defaults to now, which is what makes the default answer "the future".

tostring date-time

Upper bound: shifts starting before this instant. ISO-8601 with an explicit offset. Must be after from when from is given; sent alone it is simply an upper bound over the default lower bound of now, so a to in the past legitimately returns an empty page. Omit for no upper bound.

per_pageinteger

Page size. Defaults to 100, maximum 200.

Response

A page of shifts. Alongside data the body carries the usual pagination fields (current_page, last_page, per_page, total).

current_pageinteger
last_pageinteger
per_pageinteger
totalinteger

Changes

No recorded changes to this operation across all 1 revision of this API.