List caregivers

get/v1/caregivers

Returns a page of caregivers. 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.

status

string

Only return caregivers with this employment status.

One ofActiveOnLeaveInactive

active

boolean

Only return caregivers who can (true) or cannot (false) be scheduled.

office_id

string

Only return caregivers from this office.

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 caregivers on this page.

Show item attributesHide item attributes(27)

object

stringrequiredread-only

String representing the object's type. Always caregiver.

stringrequiredread-only

Unique identifier of the caregiver.

firstName

string | nullrequiredmax length 100

Given name.

middleName

string | nullrequiredmax length 100

Middle name.

lastName

string | nullrequiredmax length 100

Family name.

goesByName

string | nullrequiredmax length 100

The name the caregiver prefers to be called.

string · email | nullrequiredmax length 320

Work email address.

status

string | nullrequired

Employment status.

One ofActiveOnLeaveInactivenull

active

boolean | nullrequired

Whether the caregiver can be scheduled. If you leave it out on create, it is false for an Inactive status and true otherwise.

dateOfBirth

string · date | nullrequired

Date of birth.

gender

string | nullrequiredmax length 50

Gender as recorded by the agency.

primaryLanguage

string | nullrequiredmax length 50

Language the caregiver is most comfortable speaking.

address

string | nullrequiredmax length 200

Home street address.

city

string | nullrequiredmax length 100

City.

state

string | nullrequiredmax length 50

State, as a two-letter code.

zipCode

string | nullrequiredmax length 20

ZIP code.

officeId

string | nullrequiredmax length 64

The office (branch) the caregiver works from.

licenseType

string | nullrequiredmax length 50

License or credential type.

npiNumber

string | nullrequiredmax length 20

National Provider Identifier, for licensed clinicians.

stateLicenseNumber

string | nullrequiredmax length 50

State license number.

stateLicenseState

string | nullrequiredmax length 50

State that issued the license.

stateLicenseExpiry

string | nullrequiredmax length 20

License expiry date, as YYYY-MM-DD.

isLiveInCaregiver

boolean | nullrequired

Whether the caregiver works live-in shifts.

schedulingNotes

string | nullrequiredmax length 20000

Notes schedulers see when booking this caregiver.

lastVisit

string · date | nullrequiredread-only

Date of the caregiver's most recent visit.

createdAt

string · date-time | nullrequiredread-only

When the caregiver was created.

updatedAt

string · date-time | nullrequiredread-only

When the caregiver 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.