Retrieve a visit

get/v1/visits/{id}

Returns one visit by ID.

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

Path parameters

stringrequired

ID of the visit.

Response

200

The visit.

object

stringread-only

String representing the object's type. Always visit.

stringread-only

Unique identifier of the visit.

patientId

string | nullmax length 64

The patient being visited.

caregiverId

string | nullmax length 64

The caregiver assigned to the visit; null for an open shift.

startTime

string · date-time | null

Scheduled start.

endTime

string · date-time | null

Scheduled end.

status

string | null

Where the visit is in its day. New visits are Scheduled.

One ofScheduledInProgressCancelledCompletedLateOverTimeIncompletenull

title

string | nullmax length 200

Short title shown on the schedule.

isAllDay

boolean | null

Whether the visit spans the whole day, such as a live-in shift.

tasks

array of strings | null

Tasks the caregiver should complete during the visit.

reason

string | nullmax length 20000

Why the visit is scheduled, if it is not routine.

notes

string | nullmax length 20000

Notes for the caregiver about this visit.

serviceCode

string | nullmax length 50

Billing service code for the visit.

locationAddress

string | nullmax length 300

Where the visit takes place, when it is not the patient's home address.

actualStartTime

string · date-time | nullread-only

When the caregiver clocked in.

actualEndTime

string · date-time | nullread-only

When the caregiver clocked out.

completedTasks

array of strings | nullread-only

Tasks the caregiver marked done.

evvVerified

boolean | nullread-only

Whether the visit passed electronic visit verification.

evvStatus

string | nullread-only

Electronic visit verification status.

One ofPendingValidatedFlaggedOverriddenExportedSubmittednull

billingStatus

string | nullread-only

Whether the visit has been billed.

One ofNotBilledPendingInvoicedPaidnull

invoiceId

string | nullread-onlymax length 64

The invoice the visit was billed on.

billableHours

number | nullread-only

Hours billed for the visit.

isRecurring

boolean | nullread-only

Whether the visit belongs to a repeating series.

recurrenceSeriesId

string | nullread-onlymax length 64

The repeating series the visit belongs to.

caregiverRSVP

string | nullread-only

The caregiver's response to the assignment.

One ofconfirmeddeclinednull

createdAt

string · date-time | nullread-only

When the visit was created.

updatedAt

string · date-time | nullread-only

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

Errors

Status	Code	Meaning
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`).
404	n/a	No such object, or it is not visible to this key (`not_found`).
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.