Retrieve a shift swap

get/v1/shift-swaps/{id}

Returns one shift swap by ID. Available to keys belonging to office staff and caregivers.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

Path parameters

stringrequired

ID of the shift swap.

Response

200

The shift swap.

object

stringread-only

String representing the object's type. Always shift_swap.

stringread-only

Unique identifier of the shift swap.

visitId

string | nullmax length 64

The visit to hand over.

requestingCaregiverId

string | nullmax length 64

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.

requestingCaregiverName

string | nullread-onlymax length 2000

Display name of the requesting caregiver, taken from the caregiver's record.

targetCaregiverId

string | nullmax length 64

The caregiver asked to take the visit.

targetCaregiverName

string | nullmax length 200

Display name of the target caregiver.

reason

string | nullmax length 20000

Why the swap is requested.

status

string | null

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.

One ofPendingAcceptedDeclinedCancelledAdminApprovedAdminDeniednull

requestDate

string · date-time | null

When the swap was requested.

responseDate

string · date-time | nullread-only

When the target caregiver answered.

adminResponseDate

string · date-time | nullread-only

When the office answered.

createdAt

string · date-time | nullread-only

When the shift swap was created.

updatedAt

string · date-time | nullread-only

When the shift swap was last changed.

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
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`).
404	n/a	No such object, or it is not visible to this key (`not_found`).
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.