Availability

When a caregiver can or cannot work. A window is either a weekly recurring time on one weekday, or a one-off date range such as time off.

Endpoints

The Availability object

object

stringread-only

String representing the object's type. Always availability.

stringread-only

Unique identifier of the availability window.

caregiverId

string | nullmax length 64

The caregiver.

isAvailable

boolean | null

true when the caregiver can work in this window, false for time off.

recurring

boolean | null

Whether the window repeats weekly.

dayOfWeek

integer | nullmin 0max 6

For weekly windows, the weekday: 0 is Sunday, 6 is Saturday.

startMinute

integer | nullmin 0max 1440

For weekly windows, the start time in minutes after midnight.

endMinute

integer | nullmin 0max 1440

For weekly windows, the end time in minutes after midnight.

intervalWeeks

integer | nullmin 1

For weekly windows, repeat every this many weeks. Defaults to every week.

effectiveFrom

string · date | null

First date a weekly window applies.

effectiveTo

string · date | null

Last date a weekly window applies; null for no end.

startDateTime

string · date-time | null

For one-off windows, when it starts.

endDateTime

string · date-time | null

For one-off windows, when it ends.

isPreferred

boolean | null

Whether these are the caregiver's preferred hours.

reason

string | nullmax length 500

Why the caregiver is unavailable, for time off.

isActive

boolean | null

Whether the window is in effect.

createdAt

string · date-time | nullread-only

When the availability window was created.

updatedAt

string · date-time | nullread-only

When the availability window was last changed.