Who can cover a shift
Staff at the shift's location who may work its position and are free: no overlapping shift, no approved or pending leave, and not unavailable. The list is not ranked.
Needs the roster:read permission, depending on the operation. The business sees it as "Rosters and shifts".
Fields
| Field | Type | Access | Meaning |
|---|---|---|---|
| employee_id | string | Read-only | Someone free to work the shift. |
| employment_id | string | Read-only | Their employment. |
Operations
List who can cover a shift
GET/v1/shifts/{id}/covers
Permission: roster:read
{
"data": [
{
"employee_id": "66f1c2a4b3d9e8f7a6b5c4d3",
"employment_id": "66f1c2a4b3d9e8f7a6b5c4d3"
}
],
"has_more": true,
"next_cursor": "text"
}| Status | When |
|---|---|
| 400 | The error's code is invalid_request or range_too_long. The Errors page describes each code. |
| 401 | The error's code is invalid_token or token_expired. The Errors page describes each code. |
| 403 | The error's code is origin_not_allowed, permission_denied, not_available, connection_disconnected, connection_suspended or app_suspended. The Errors page describes each code. |
| 404 | There is nothing at this address, or no such record in this business. |
| 429 | Too many requests. Retry-After says when to try again. |
| 500 | Something went wrong at Shiftly. Quote the request id. |
| 503 | This environment is not set up for partner apps yet. |