Skip to main content
POST
/
user
/
coverage_requests
Request coverage
curl --request POST \
  --url https://api.shiftkeeper.io/user/coverage_requests/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "start": "2023-11-07T05:31:56Z",
  "end": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "schedule_ids": [
    "<string>"
  ]
}
'
{
  "coverage_request": {
    "id": "<string>",
    "reason": "<string>",
    "user": {
      "id": "<string>",
      "name": "<string>",
      "email": "jsmith@example.com",
      "time_zone": "<string>",
      "slack_id": "<string>"
    },
    "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": "jsmith@example.com",
      "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>"
        }
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.shiftkeeper.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Body

application/json
​
start
string<date-time>
required

The start date and time of the interval you need coverage for.

​
end
string<date-time>
required

The end date and time of the interval you need coverage for.

​
reason
string
required

The reason you need coverage.

Required string length: 1 - 300
​
schedule_ids
string[]

You can optionally limit the coverage request to specific schedules. If not provided, the coverage request will include all schedules you are a member of.

Response

Default Response

​
coverage_request
object
required
Example:
{
  "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"
      }
    }
  ]
}