---
title: "Get Patient Sidebar Snapshot"
method: GET
path: "/user/patient/{patient_id}/sidebar-counts"
tags: ["provider", "user"]
---

# Get Patient Sidebar Snapshot

`GET /user/patient/{patient_id}/sidebar-counts`

## Request

- Base URL: `https://docs.decodahealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.decodahealth.com/user/patient/{patient_id}/sidebar-counts`
- Auth: none declared. Required headers: `TENANT`, `API-KEY`
- TypeScript: <https://skmtc.dev/decodahealth/apis/decoda-api/docs/user/patient/:patient_id/sidebar-counts/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `patient_id` string, required

## Query parameters

- `include_cancelled` boolean, nullable

## Headers

- `TENANT` string, required
- `API-KEY` string, required

## Response `200`

Successful Response

- PatientSidebarSnapshot: 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: Count of memos (quick notes without event)
  - `appointmentsCount` integer: Count of patient events (not archived)
  - `chargesCount` integer: Count of charges for patient
  - `paymentMethodsCount` integer: Count of active payment methods (excluding Apple Pay)
  - `formsCount` integer: Count of completed form submissions for patient
  - `notesCount` integer: Count of latest-note threads for patient
  - `documentsCount` integer: Count of documents for patient
  - `attachmentsCount` integer: Count of attachments per attachment-history rules

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/decodahealth/apis/decoda-api.md) - [All operations](https://skmtc.dev/decodahealth/apis/decoda-api/llms.txt) - [OpenAPI document](https://skmtc.dev/decodahealth/apis/decoda-api/revisions/4ab18c80f9e9?raw)