Email

Access email records, drafts, and attachments for patients.

The Email API provides read access to email records associated with patients, including draft emails and attachments.

Base path: /{tenantName}/{instanceName}/patients/{patientId}/emails

---

Endpoints

GET Get All Emails

GET /{tenantName}/{instanceName}/patients/{patientId}/emails

Returns all email records for a patient.

Query Parameters

Parameter	Type	Default	Description
page	integer	0	Page number
size	integer	20	Results per page
status	string	—	Filter by SENT, DRAFT, RECEIVED

Example Response 200 OK

{
  "data": [
    {
      "id": "email-uuid",
      "patientId": "a1b2c3d4",
      "subject": "Care Plan Update",
      "direction": "OUTBOUND",
      "status": "SENT",
      "sentAt": "2026-03-18T11:00:00Z",
      "hasAttachment": true
    }
  ]
}

---

GET Get Email by ID

GET /{tenantName}/{instanceName}/patients/{patientId}/emails/{emailId}

Returns a single email record with full content and metadata.

---

GET Download Email Attachment

GET /{tenantName}/{instanceName}/patients/{patientId}/emails/{emailId}/attachment

Downloads a file attachment from an email record.

---

Email Drafts

GET Get All Email Drafts

GET /{tenantName}/{instanceName}/patients/{patientId}/email-drafts

Returns all saved email drafts for a patient that have not yet been sent.

GET Get Email Draft by ID

GET /{tenantName}/{instanceName}/patients/{patientId}/email-drafts/{draftId}