List availability windows

get/v1/availability

Returns a page of availability windows. Filters combine with AND. Use next_cursor to fetch the next page. 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

Query parameters

limit

integerdefault: 25min 1max 100

Number of objects to return, from 1 to 100.

cursor

string

The next_cursor from the previous page. Send the same filters with it.

caregiver_id

string

Only return windows of this caregiver.

created_after

string · date-time

Only return objects created after this time (exclusive). ISO 8601 with a time zone.

created_before

string · date-time

Only return objects created before this time (exclusive). ISO 8601 with a time zone.

updated_after

string · date-time

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.

updated_before

string · date-time

Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.

Response

200

A page of results.

object

string

Always list.

data

array of objects

The availability windows on this page.

Show item attributesHide item attributes(18)

object

stringrequiredread-only

String representing the object's type. Always availability.

stringrequiredread-only

Unique identifier of the availability window.

caregiverId

string | nullrequiredmax length 64

The caregiver.

isAvailable

boolean | nullrequired

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

recurring

boolean | nullrequired

Whether the window repeats weekly.

dayOfWeek

integer | nullrequiredmin 0max 6

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

startMinute

integer | nullrequiredmin 0max 1440

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

endMinute

integer | nullrequiredmin 0max 1440

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

intervalWeeks

integer | nullrequiredmin 1

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

effectiveFrom

string · date | nullrequired

First date a weekly window applies.

effectiveTo

string · date | nullrequired

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

startDateTime

string · date-time | nullrequired

For one-off windows, when it starts.

endDateTime

string · date-time | nullrequired

For one-off windows, when it ends.

isPreferred

boolean | nullrequired

Whether these are the caregiver's preferred hours.

reason

string | nullrequiredmax length 500

Why the caregiver is unavailable, for time off.

isActive

boolean | nullrequired

Whether the window is in effect.

createdAt

string · date-time | nullrequiredread-only

When the availability window was created.

updatedAt

string · date-time | nullrequiredread-only

When the availability window was last changed.

next_cursor

string | null

Pass as cursor to fetch the next page. null on the last page.

has_more

boolean

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.