List visit requests

get/v1/visit-requests

Returns a page of visit requests. 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 requests from this caregiver.

status

string

Only return requests with this status.

One ofPendingApprovedDeniedCancelled

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

Show item attributesHide item attributes(16)

object

stringrequiredread-only

String representing the object's type. Always visit_request.

stringrequiredread-only

Unique identifier of the visit request.

caregiverId

string | nullrequiredmax length 64

The caregiver asking for the visit. With a caregiver's API key this is always that caregiver (leave it out); office staff must send it.

caregiverName

string | nullrequiredread-onlymax length 2000

Caregiver's display name, taken from the caregiver's record.

patientId

string | nullrequiredmax length 64

The patient the caregiver would visit.

patientName

string | nullrequiredmax length 200

Patient's display name.

preferredStartDate

string · date | nullrequired

First date the caregiver could start.

preferredEndDate

string · date | nullrequired

Last date of the request.

preferredTimeOfDay

string | nullrequiredmax length 100

Time of day the caregiver prefers.

reason

string | nullrequiredmax length 20000

Why the caregiver is asking.

status

string | nullrequired

Where the request stands. A caregiver's key creates Pending requests and can only change its own pending request to Cancelled; approving and denying is for office staff.

One ofPendingApprovedDeniedCancellednull

adminResponse

string | nullrequiredmax length 20000

The office's reply. Set by office staff.

respondedByName

string | nullrequiredread-onlymax length 2000

Who answered the request.

respondedAt

string · date-time | nullrequiredread-only

When the request was answered.

createdAt

string · date-time | nullrequiredread-only

When the visit request was created.

updatedAt

string · date-time | nullrequiredread-only

When the visit request 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.