Skip to main content
GET
Get Patient Sidebar Snapshot

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

patient_id
string
required

Query Parameters

include_cancelled
boolean | null
default:false

Response

Successful Response

Snapshot for patient sidebar: counts + today's appointments list.

Fields use snake_case per backend conventions. Frontend middleware will map these to camelCase for TypeScript consumers.

memosCount
integer
default:0

Count of memos (quick notes without event)

appointmentsCount
integer
default:0

Count of patient events (not archived)

chargesCount
integer
default:0

Count of charges for patient

paymentMethodsCount
integer
default:0

Count of active payment methods (excluding Apple Pay)

formsCount
integer
default:0

Count of completed form submissions for patient

notesCount
integer
default:0

Count of latest-note threads for patient

documentsCount
integer
default:0

Count of documents for patient

attachmentsCount
integer
default:0

Count of attachments per attachment-history rules