Skip to main content
GET
/
user
/
patient
/
{patient_id}
/
sidebar-counts
Get Patient Sidebar Snapshot
curl --request GET \
  --url https://api.decodahealth.com/user/patient/{patient_id}/sidebar-counts \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "memosCount": 0,
  "appointmentsCount": 0,
  "chargesCount": 0,
  "paymentMethodsCount": 0,
  "formsCount": 0,
  "notesCount": 0,
  "documentsCount": 0,
  "attachmentsCount": 0
}

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