List shift swaps
/v1/shift-swapsReturns a page of shift swaps. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff and caregivers.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return swaps with this status.
PendingAcceptedDeclinedCancelledAdminApprovedAdminDeniedOnly return swaps for this visit.
Only return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The shift swaps on this page.
Show item attributesHide item attributes(14)
String representing the object's type. Always shift_swap.
Unique identifier of the shift swap.
The visit to hand over.
The caregiver giving up the visit. With a caregiver's API key this is always that caregiver (leave it out), and the visit must be assigned to them; office staff must send it.
Display name of the requesting caregiver, taken from the caregiver's record.
The caregiver asked to take the visit.
Display name of the target caregiver.
Why the swap is requested.
Where the swap stands. With a caregiver's key: new swaps are Pending; the asked caregiver changes a Pending swap to Accepted or Declined; the requesting caregiver can change it to Cancelled. AdminApproved and AdminDenied are for office staff.
PendingAcceptedDeclinedCancelledAdminApprovedAdminDeniednullWhen the swap was requested.
When the target caregiver answered.
When the office answered.
When the shift swap was created.
When the shift swap was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.