Shift Swaps
Requests from one caregiver to hand a visit to another, which the other caregiver and then the office approve.
Endpoints
The ShiftSwap object
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.