Sign in

v2

latestSwagger 2.02026-07-26109144190.4 KB
Rotations

Get a specific shift

Retrieve a specific shift within a rotation group, including on-call period details.

This API may be called a maximum of 2 times per second.

get/api-public/v1/teams/{team}/rotations/{groupId}/{shiftId}

Path parameters

teamstring required

The team slug

groupIdinteger required

The rotation group ID

shiftIdinteger required

The rotation shift ID

Query parameters

skipinteger

Number of weeks to skip for the on-call period preview

countinteger

Number of weeks to show for the on-call period preview

Headers

X-VO-Api-Idstring required

Your API ID

X-VO-Api-Keystring required

Your API Key

Response

The shift with on-call period details

org_slugstring
team_slugstring
rot_idinteger

The shift/rotation ID

group_idinteger

The parent rotation group ID

labelstring

The name of the shift

timezonestring

The timezone of the shift

startinteger

The start time of the shift in epoch milliseconds

durationinteger

The duration of the shift in days

shifttype'std' | 'fts' | 'cstm' | 'pho'

The type of shift: std, fts, cstm, or pho

oncallstring

The username of the currently on-call user

usernamesstring[]

Usernames of the members in this shift