---
title: "List Patient Letters"
method: GET
path: "/api/2.0/patient_letters/"
tags: ["Patient Letters (BETA)"]
---

# List Patient Letters

`GET /api/2.0/patient_letters/`

List patient-facing letters (both directions). Filter by patient, practice, or unread=true.

## Query parameters

- `document_date__gt` string, date-time
- `document_date__gte` string, date-time
- `document_date__lt` string, date-time
- `document_date__lte` string, date-time
- `limit` integer
- `offset` integer
- `patient` integer[]
- `practice` integer[]
- `unread` boolean

## Response `200`

- PaginatedPatientLetterList
  - `count` integer
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` PatientLetter[], required
    - `attachments` LetterAttachment[]
      - `attachment_type` 'Entity' | 'RefPanel' | 'PatientDemog' | 'ImmHistory' | 'MedsList' | 'CompMedsList' | 'WhoHeightChart' | 'WhoWeightChart' | 'WhoHcChart' | 'WhoWflChart' | 'CdcHeightChart' | 'CdcWeightChart' | 'CdcBmiChart' | 'CdcHcChart' | 'PremieHeightChart' | 'PremieWeightChart' | 'PremieHcChart' | 'DsinfantHeightChart' | 'DsinfantWeightChart' | 'DsinfantHcChart' | 'DsHeightChart' | 'DsWeightChart' | 'DsBmiChart' | 'DsHcChart', required — * `Entity` - Entity * `RefPanel` - RefPanel * `PatientDemog` - PatientDemog * `ImmHistory` - ImmHistory * `MedsList` - MedsList * `CompMedsList` - CompMedsList * `WhoHeightChart` - WhoHeightChart * `WhoWeightChart` - WhoWeightChart * `WhoHcChart` - WhoHcChart * `WhoWflChart` - WhoWflChart * `CdcHeightChart` - CdcHeightChart * `CdcWeightChart` - CdcWeightChart * `CdcBmiChart` - CdcBmiChart * `CdcHcChart` - CdcHcChart * `PremieHeightChart` - PremieHeightChart * `PremieWeightChart` - PremieWeightChart * `PremieHcChart` - PremieHcChart * `DsinfantHeightChart` - DsinfantHeightChart * `DsinfantWeightChart` - DsinfantWeightChart * `DsinfantHcChart` - DsinfantHcChart * `DsHeightChart` - DsHeightChart * `DsWeightChart` - DsWeightChart * `DsBmiChart` - DsBmiChart * `DsHcChart` - DsHcChart
      - `entity_date` string, date-time, nullable
      - `entity_description` string, nullable
      - `entity_id` integer
      - `entity_type` integer, nullable
      - `handout` integer, nullable
      - `id` integer
      - `summary` string, nullable
    - `body` string
    - `category` integer, nullable
    - `created_date` string, date-time, nullable
    - `deleted_date` string, date-time, nullable
    - `delivery_date` string, date-time, nullable
    - `document_date` string, date-time
    - `files` S3RetrievingDocumentFile[], nullable — Files attached to this letter. Binary upload: set content_type='application/octet-stream' and provide 'base64_content' (and optional 'original_filename'). When any file uses base64, all files in the same request must use base64. On GET, returns file references.
      - `base64_content` string
      - `content_type` string
      - `document` string, uri — URL to retrieve the document
      - `external_content` unknown
      - `id` integer
      - `original_filename` string
    - `id` integer
    - `is_patient_initiated` boolean, nullable
    - `is_processed` boolean
    - `letter_type` string
    - `patient` integer, required
    - `patient_read_time` string, date-time, nullable
    - `practice` integer, required
    - `send_out` boolean
    - `send_to_patient` boolean
    - `sign_date` string, date-time, nullable
    - `signed_by` integer, nullable — The user who signed the letter.
    - `subject` string
    - `tags` integer[] — A list of Document Tags associated with the letter.
    - `viewed_at` string, date-time, nullable

---

[API](https://skmtc.net/elationhealth/apis/api-authentication.md) · [All operations](https://skmtc.net/elationhealth/apis/api-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elationhealth/api-authentication/versions/c060f89d4de7/schema)
