List progress notes

get/v1/progress-notes

Returns a page of progress notes. 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.

patient_id

string

Only return notes for this patient.

visit_id

string

Only return notes for this visit.

caregiver_id

string

Only return notes by this caregiver.

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 progress notes on this page.

Show item attributesHide item attributes(10)

object

stringrequiredread-only

String representing the object's type. Always progress_note.

stringrequiredread-only

Unique identifier of the progress note.

visitId

string | nullrequiredmax length 64

The visit the note documents.

patientId

string | nullrequiredmax length 64

The patient.

caregiverId

string | nullrequiredmax 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 | nullrequiredread-onlymax length 2000

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

summary

string | nullrequiredmax length 20000

The written summary of the visit.

aiGenerated

boolean | nullrequiredread-only

Whether the summary was drafted with AI assistance.

createdAt

string · date-time | nullrequiredread-only

When the progress note was created.

updatedAt

string · date-time | nullrequiredread-only

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