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
List coverage requests
Copy
curl --request GET \
--url https://api.shiftkeeper.io/coverage_requests/ \
--header 'x-api-key: <api-key>'Copy
{
"coverage_requests": [
{
"id": "<string>",
"reason": "<string>",
"user": {
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"role": "owner",
"seat": "viewer",
"time_zone": "<string>",
"slack_id": "<string>"
},
"status": "pending",
"shifts": [
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"schedule_reference": {
"id": "<string>",
"name": "<string>"
}
}
],
"accepted_by": {
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"role": "owner",
"seat": "viewer",
"time_zone": "<string>",
"slack_id": "<string>"
},
"accepted_shifts": [
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"schedule_reference": {
"id": "<string>",
"name": "<string>"
}
}
]
}
],
"meta": {
"total": 123,
"page": 123,
"per_page": 123
}
}Coverage
List coverage requests
List all coverage requests in your organization.
GET
/
coverage_requests
List coverage requests
Copy
curl --request GET \
--url https://api.shiftkeeper.io/coverage_requests/ \
--header 'x-api-key: <api-key>'Copy
{
"coverage_requests": [
{
"id": "<string>",
"reason": "<string>",
"user": {
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"role": "owner",
"seat": "viewer",
"time_zone": "<string>",
"slack_id": "<string>"
},
"status": "pending",
"shifts": [
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"schedule_reference": {
"id": "<string>",
"name": "<string>"
}
}
],
"accepted_by": {
"id": "<string>",
"name": "<string>",
"email": "[email protected]",
"role": "owner",
"seat": "viewer",
"time_zone": "<string>",
"slack_id": "<string>"
},
"accepted_shifts": [
{
"start": "2023-11-07T05:31:56Z",
"end": "2023-11-07T05:31:56Z",
"schedule_reference": {
"id": "<string>",
"name": "<string>"
}
}
]
}
],
"meta": {
"total": 123,
"page": 123,
"per_page": 123
}
}Authorizations
Enter your API key which starts with 'keeper_'
Query Parameters
The number of items per page.
Required range:
1 <= x <= 100The page number of the results to return.
Required range:
x >= 1Response
200 - application/json
Default Response
Show child attributes
Show child attributes
The ID of the coverage request.
The reason for the coverage request.
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.
Available options:
pending, accepted, canceled, expired Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
⌘I