Skip to main content
GET
List patient notes

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

X-Organization-Id
string
required

Target clinic organization ID

Query Parameters

patientId
string

Filter by patient ID (UUID)

Example:

"8de03039-3a9e-417a-b2b3-a8b8df183631"

facilityId
string

Filter by facility ID (UUID)

Example:

"a1b2c3d4-5678-4abc-9def-0123456789ab"

providerId
string

Filter by assigned provider ID (UUID) — returns notes where this provider is assigned in any role

Example:

"d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a"

dateFrom
string

Filter notes with visit date on or after this date (ISO 8601)

Example:

"2025-01-01"

dateTo
string

Filter notes with visit date on or before this date (ISO 8601)

Example:

"2025-12-31"

status
string

Filter by workflow status (comma-separated)

Example:

"synced,awaiting_sign"

aiStatus
string

Filter by AI status (comma-separated)

Example:

"issues_found,success"

updatedSince
string

Only return notes whose record was created or modified at/after this timestamp (ISO 8601). Filters on the record's updated_at — unlike dateFrom/dateTo (visit date), this catches a note signed today for a visit last month. When set, results are ordered by updatedAt ascending so pages are monotonic: page through to the end, then use the LAST row's updatedAt as the next cursor. Do not advance the cursor mid-pagination.Rows sharing the boundary updatedAt can re-deliver on the next pull, since the bound is inclusive — dedupe on id.

Example:

"2025-06-01T00:00:00.000Z"

updatedUntil
string

Only return notes whose record was last modified at/before this timestamp (ISO 8601).

Example:

"2025-06-30T23:59:59.999Z"

includeSoapNote
boolean

Include SOAP note content (requires read:soap_notes scope)

Example:

"false"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required