Create a caregiver

post/v1/caregivers

Creates a caregiver and returns it. Send an Idempotency-Key header to make the request safe to retry. Available to keys belonging to office staff. Requires a key with write scope.

Authorization

Authorization: Bearer ak_...requiredscope: read + write

An AveeCare API key created in Settings → API Keys. This endpoint changes data, so the key needs read + write scope. About authentication

Headers

Idempotency-Key

stringmax length 255

A unique value (a UUID works well) that makes this request safe to retry for 24 hours. A retry with the same key and body returns the first result; the same key with a different body is refused with idempotency_conflict.

Request body

application/json

firstName

stringrequiredmax length 100

Given name.

middleName

string | nullmax length 100

Middle name.

lastName

stringrequiredmax length 100

Family name.

goesByName

string | nullmax length 100

The name the caregiver prefers to be called.

string · email | nullmax length 320

Work email address.

status

string | null

Employment status.

One ofActiveOnLeaveInactivenull

active

boolean | null

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 | null

Date of birth.

gender

string | nullmax length 50

Gender as recorded by the agency.

primaryLanguage

string | nullmax length 50

Language the caregiver is most comfortable speaking.

address

string | nullmax length 200

Home street address.

city

string | nullmax length 100

City.

state

string | nullmax length 50

State, as a two-letter code.

zipCode

string | nullmax length 20

ZIP code.

officeId

string | nullmax length 64

The office (branch) the caregiver works from.

licenseType

string | nullmax length 50

License or credential type.

npiNumber

string | nullmax length 20

National Provider Identifier, for licensed clinicians.

stateLicenseNumber

string | nullmax length 50

State license number.

stateLicenseState

string | nullmax length 50

State that issued the license.

stateLicenseExpiry

string | nullmax length 20

License expiry date, as YYYY-MM-DD.

isLiveInCaregiver

boolean | null

Whether the caregiver works live-in shifts.

schedulingNotes

string | nullmax length 20000

Notes schedulers see when booking this caregiver.

Response

201

The new caregiver.

object

stringread-only

String representing the object's type. Always caregiver.

stringread-only

Unique identifier of the caregiver.

firstName

string | nullmax length 100

Given name.

middleName

string | nullmax length 100

Middle name.

lastName

string | nullmax length 100

Family name.

goesByName

string | nullmax length 100

The name the caregiver prefers to be called.

string · email | nullmax length 320

Work email address.

status

string | null

Employment status.

One ofActiveOnLeaveInactivenull

active

boolean | null

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 | null

Date of birth.

gender

string | nullmax length 50

Gender as recorded by the agency.

primaryLanguage

string | nullmax length 50

Language the caregiver is most comfortable speaking.

address

string | nullmax length 200

Home street address.

city

string | nullmax length 100

City.

state

string | nullmax length 50

State, as a two-letter code.

zipCode

string | nullmax length 20

ZIP code.

officeId

string | nullmax length 64

The office (branch) the caregiver works from.

licenseType

string | nullmax length 50

License or credential type.

npiNumber

string | nullmax length 20

National Provider Identifier, for licensed clinicians.

stateLicenseNumber

string | nullmax length 50

State license number.

stateLicenseState

string | nullmax length 50

State that issued the license.

stateLicenseExpiry

string | nullmax length 20

License expiry date, as YYYY-MM-DD.

isLiveInCaregiver

boolean | null

Whether the caregiver works live-in shifts.

schedulingNotes

string | nullmax length 20000

Notes schedulers see when booking this caregiver.

lastVisit

string · date | nullread-only

Date of the caregiver's most recent visit.

createdAt

string · date-time | nullread-only

When the caregiver was created.

updatedAt

string · date-time | nullread-only

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

Idempotent-ReplayedstringPresent and true when this response is the stored result of an earlier request with the same Idempotency-Key.

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`).
409	n/a	The `Idempotency-Key` was already used with a different request, or that request is still running (`idempotency_conflict`).
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.