Using the API
Schedules
- GETList schedules
- POSTCreate a schedule
- GETGet a schedule
- DELDelete a schedule
- PATCHUpdate a schedule
- GETList schedule shifts
- GETGet the Slack user group for a schedule
- PUTAttach or update the Slack user group for a schedule
- DELDetach the Slack user group from a schedule
- GETList linked schedule Slack channels
- PUTLink a Slack channel to a schedule
- DELUnlink a Slack channel from a schedule
Overrides
Coverage
Get a schedule override
Copy
curl --request GET \
--url https://api.shiftkeeper.io/schedules/{schedule_id}/overrides/{override_id} \
--header 'x-api-key: <api-key>'Copy
{
"override": {
"id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"role": "owner",
"seat": "viewer",
"time_zone": "<string>",
"slack_id": "<string>"
}
]
}
}Overrides
Get a schedule override
Get a schedule override by its ID.
GET
/
schedules
/
{schedule_id}
/
overrides
/
{override_id}
Get a schedule override
Copy
curl --request GET \
--url https://api.shiftkeeper.io/schedules/{schedule_id}/overrides/{override_id} \
--header 'x-api-key: <api-key>'Copy
{
"override": {
"id": "<string>",
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"users": [
{
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"role": "owner",
"seat": "viewer",
"time_zone": "<string>",
"slack_id": "<string>"
}
]
}
}Authorizations
Enter your API key which starts with 'keeper_'
Path Parameters
The ID of the override.
The ID of the schedule.
Response
Default Response
Show child attributes
Show child attributes
The ID of the override.
The start date and time of the override.
The end date and time of the override.
The on-call users during the override.
Show child attributes
Show child attributes
The ID of the user.
The name of the user.
The email of the user.
The preferred time zone of the user. If not set, the organization's time zone will be used.
The Slack ID of the user.
⌘I