Skip to main content
GET
List on-call shifts for the authenticated user

Authorizations

x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Query Parameters

per_page
number
default:20

The number of items per page.

Required range: 1 <= x <= 100
page
number
default:1

The page number of the results to return.

Required range: x >= 1
from
string<date-time>
required

The start date and time of the interval to list on-call shifts for.

to
string<date-time>
required

The end date and time of the interval to list on-call shifts for.

clip_to_interval
boolean

If set to true, the on-call shifts which go outside of the interval specified by from and to will be clipped to the interval bounds.

Response

Default Response

shifts
object[]
required
meta
object
required
Example: