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 for the authenticated user
List all coverage requests for the authenticated user.
curl --request GET \
--url https://api.shiftkeeper.io/user/coverage_requests/ \
--header 'x-api-key: <api-key>'
{
"coverage_requests": [
{
"id": "cov_RxQottluZ1oeM47nz4bVl",
"user": {
"id": "usr_bq7CmsOKLmkMeZkUUu1hy",
"name": "Rick",
"email": "rick@example.org",
"time_zone": "Europe/Paris",
"role": "owner",
"seat": "member",
"slack_id": "U082KENSEQ3"
},
"reason": "I will be out of office during this week. Could someone jump in to cover these shifts?",
"status": "pending",
"shifts": [
{
"start": "2024-12-02T09:00:00Z",
"end": "2024-12-02T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-03T09:00:00Z",
"end": "2024-12-03T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-04T09:00:00Z",
"end": "2024-12-04T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-05T09:00:00Z",
"end": "2024-12-05T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-06T09:00:00Z",
"end": "2024-12-06T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-01T00:00:00Z",
"end": "2024-12-08T00:00:00Z",
"schedule_reference": {
"id": "sch_ldYmnBVr5o2ikebwmRRZv",
"name": "Citadel"
}
}
]
}
],
"meta": {
"total": 100,
"page": 1,
"per_page": 20
}
}
Authorizations
Enter your API key which starts with 'keeper_'
Query Parameters
The number of items per page.
1 < x < 100
The page number of the results to return.
x > 1
Response
The ID of the coverage request.
The reason for the coverage request.
The ID of the user.
The name of the user.
The email of the user.
The role of the user. Learn more about roles in our docs.
owner
, standard
The seat of the user. Learn more about seat in our docs.
viewer
, member
The preferred time zone of the user. If not set, the organization's time zone will be used.
The Slack ID of the user.
pending
, accepted
, canceled
, expired
The ID of the user.
The name of the user.
The email of the user.
The role of the user. Learn more about roles in our docs.
owner
, standard
The seat of the user. Learn more about seat in our docs.
viewer
, member
The preferred time zone of the user. If not set, the organization's time zone will be used.
The Slack ID of the user.
curl --request GET \
--url https://api.shiftkeeper.io/user/coverage_requests/ \
--header 'x-api-key: <api-key>'
{
"coverage_requests": [
{
"id": "cov_RxQottluZ1oeM47nz4bVl",
"user": {
"id": "usr_bq7CmsOKLmkMeZkUUu1hy",
"name": "Rick",
"email": "rick@example.org",
"time_zone": "Europe/Paris",
"role": "owner",
"seat": "member",
"slack_id": "U082KENSEQ3"
},
"reason": "I will be out of office during this week. Could someone jump in to cover these shifts?",
"status": "pending",
"shifts": [
{
"start": "2024-12-02T09:00:00Z",
"end": "2024-12-02T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-03T09:00:00Z",
"end": "2024-12-03T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-04T09:00:00Z",
"end": "2024-12-04T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-05T09:00:00Z",
"end": "2024-12-05T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-06T09:00:00Z",
"end": "2024-12-06T17:00:00Z",
"schedule_reference": {
"id": "sch_KR5uoK0xD0rWQoKTDqwgu",
"name": "Portal support"
}
},
{
"start": "2024-12-01T00:00:00Z",
"end": "2024-12-08T00:00:00Z",
"schedule_reference": {
"id": "sch_ldYmnBVr5o2ikebwmRRZv",
"name": "Citadel"
}
}
]
}
],
"meta": {
"total": 100,
"page": 1,
"per_page": 20
}
}