Erase a patient
Owner only: the right-to-erasure request. In one short transaction the patient is restricted — hidden from every staff surface, contact details cleared, nothing new attachable, nothing sent — and an erasure request opens; the patient's CRM records (journeys, activities, conversations and messages, calls, voicemails, transcripts, tasks, consent and lead history) are then removed step by step, and stored files are cleaned up separately. `erasure` reports progress and what earlier copies may still hold the person. A patient with clinical or payment records (or an account, a consent or payer relationship, an insurance subscription or referral evidence) keeps those records under a restricted identity that only the owner can open, until a computed date (`erasure.status` is `kept`). Idempotent while the request runs. A refusal is 409 with the first reason's code (PATIENT_MERGED, PATIENT_LEGAL_HOLD, PATIENT_PAYS_FOR_OTHERS, PATIENT_CARRIES_PAYER_AUTHORITY, PATIENT_HAS_LIVE_WORK — including an active membership or payment plan — or PATIENT_HAS_FAMILY_RELATIONSHIP) and every reason in details.reasons. Use Archive to hide a record while keeping its history.
Loading the API reference…
Export patients as CSV GET
Same filtering as GET /patients (q, filters, includeArchived…). `columns` selects and orders the CSV columns; `ids` restricts to a selection. The clinic's visit, recall and balance columns need appointment:read, recall:read and ledger:read (403 without). Caps at 10000 rows because the CSV is built in memory — code EXPORT_TOO_LARGE; POST /transfer/exports with entity `patients` and this query (q, filters, sort, direction, columns, ids) as `patientQuery` runs the same export in the background with no row limit.
Get a patient with tags GET
embed=timeline,journeys,touches folds the first timeline page, the patient's journeys and the capture-attribution touches into the response — a detail view's single data call.