GET
/
coverage_requests
curl --request GET \
  --url https://api.shiftkeeper.io/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

​
x-api-key
string
header
required

Enter your API key which starts with 'keeper_'

Query Parameters

​
per_page
number
default:20

The number of items per page.

Required range: 1 <= x <= 100
​
page
number
default:1

The page number of the results to return.

Required range: x >= 1

Response

200 - application/json

Default Response

​
coverage_requests
object[]
required
​
meta
object
required
Examples:
{ "total": 100, "page": 1, "per_page": 20 }