Skip to main content
GET
/
schedules
/
{schedule_id}
/
shifts
List schedule shifts
curl --request GET \
  --url https://api.shiftkeeper.io/schedules/{schedule_id}/shifts/ \
  --header 'x-api-key: <api-key>'
{
  "shifts": [
    {
      "users": [
        {
          "id": "<string>",
          "name": "<string>",
          "email": "[email protected]",
          "role": "owner",
          "seat": "viewer",
          "time_zone": "<string>",
          "slack_id": "<string>"
        }
      ],
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "per_page": 123
  }
}

Authorizations

x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Path Parameters

schedule_id
string
required

The ID of the schedule.

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
to
string<date-time>
required
clip_to_interval
boolean

Response

Default Response

shifts
object[]
required
meta
object
required