AveeCare

Retrieve a progress note

get/v1/progress-notes/{id}

Returns one progress 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 progress note.

Response

200

The progress note.

object
stringread-only

String representing the object's type. Always progress_note.

id
stringread-only

Unique identifier of the progress note.

visitId
string | nullmax length 64

The visit the note documents.

patientId
string | nullmax length 64

The patient.

caregiverId
string | nullmax length 64

The caregiver who wrote the note. With a caregiver's API key this is always that caregiver (leave it out), and the visit must be assigned to them.

caregiverName
string | nullread-onlymax length 2000

Display name of the caregiver, taken from the caregiver's record.

summary
string | nullmax length 20000

The written summary of the visit.

aiGenerated
boolean | nullread-only

Whether the summary was drafted with AI assistance.

createdAt
string · date-time | nullread-only

When the progress note was created.

updatedAt
string · date-time | nullread-only

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