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
Overrides
Override a schedule shift
Create a new schedule override.
POST
/
schedules
/
{schedule_id}
/
overrides
curl --request POST \
--url https://api.shiftkeeper.io/schedules/{schedule_id}/overrides/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"start": "2024-12-01T00:00:00Z",
"end": "2024-12-08T00:00:00Z",
"user_references": [
{
"type": "email",
"value": "dena@example.org"
}
]
}'
{
"override": {
"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"
}
]
}
}
Authorizations
Enter your API key which starts with 'keeper_'
Path Parameters
The ID of the schedule.
Body
application/json
Response
200
application/json
Default Response
The response is of type object
.
curl --request POST \
--url https://api.shiftkeeper.io/schedules/{schedule_id}/overrides/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"start": "2024-12-01T00:00:00Z",
"end": "2024-12-08T00:00:00Z",
"user_references": [
{
"type": "email",
"value": "dena@example.org"
}
]
}'
{
"override": {
"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"
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.