GET
/
schedules
/
{schedule_id}
/
overrides
curl --request GET \
  --url https://api.shiftkeeper.io/schedules/{schedule_id}/overrides/ \
  --header 'x-api-key: <api-key>'
{
  "overrides": [
    {
      "id": "ovr_i9fo8GI1YBAQhtoArC3N1",
      "start": "2024-12-01T00:00:00Z",
      "end": "2024-12-08T00:00:00Z",
      "users": [
        {
          "id": "usr_C0GwCFdk0I4pBMRny4qYV",
          "name": "Dena",
          "email": "dena@example.org",
          "role": "standard",
          "seat": "member",
          "slack_id": "U082GMAFR1T"
        }
      ]
    }
  ],
  "meta": {
    "total": 100,
    "page": 1,
    "per_page": 20
  }
}

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
required
​
to
string
required

Response

200
application/json
Default Response
​
overrides
object[]
required
​
meta
object
required
Example:
{ "total": 100, "page": 1, "per_page": 20 }