AveeCare

Retrieve a visit note

get/v1/visit-notes/{id}

Returns one visit note by ID. 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

Path parameters

id
stringrequired

ID of the visit note.

Response

200

The visit note.

object
stringread-only

String representing the object's type. Always visit_note.

id
stringread-only

Unique identifier of the visit note.

visitId
string | nullmax length 64

The visit the note is about.

content
string | nullmax length 20000

The note.

authorType
string | nullread-only

Whether office staff (User) or a caregiver wrote the note. Set from the API key's user.

One ofUserCaregivernull
authorId
string | nullread-onlymax length 64

ID of the staff user or caregiver who wrote the note. Set from the API key's user.

createdAt
string · date-time | nullread-only

When the visit note was created.

updatedAt
string · date-time | nullread-only

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

StatusCodeMeaning
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.