Skip to main content
GET
/
user
/
shifts
/
List on-call shifts for the authenticated user
curl --request GET \
  --url https://api.shiftkeeper.io/user/shifts/ \
  --header 'x-api-key: <api-key>'
{
  "shifts": [
    {
      "users": [
        {
          "id": "usr_bq7CmsOKLmkMeZkUUu1hy",
          "name": "Rick",
          "email": "rick@example.org",
          "time_zone": "Europe/Paris",
          "role": "owner",
          "seat": "member",
          "slack_id": "U082KENSEQ3"
        }
      ],
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "schedule_reference": {
        "id": "sch_xX8gfURsJtt0u9lCOAPMH",
        "name": "Incident responders"
      }
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 20
  }
}

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
Examples:
{ "total": 100, "page": 1, "per_page": 20 }