Skip to main content
GET
Export clinical notes
Safety
  • Writes data: No
  • Safe to retry: Yes
  • Contacts an outside system: None
  • Dry run: Not needed (read-only).
Pick the format with format: json (default) and csv return at most 1000 notes (meta.truncated, or the X-Result-Truncated header on csv, says when more matched); ndjson streams every matching note, one per line. Narrow large pulls with from and to. The response holds full note content, transcripts and patient context: store it as PHI. Guide: Clinical notes: export notes. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Query Parameters

patient_id
string

Filter by patient ID.

Example:

"481926357104938271"

session_id
string

Filter by session ID.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

template_id
string

Filter by the template the note was generated from.

created_by
string

Filter by authoring clinician (must be a member of your org).

note_type
string

Filter by note type.

Example:

"clinical_visit"

from
string

Only notes created on/after this date (ISO 8601).

Example:

"2026-01-01"

to
string

Only notes created on/before this date (ISO 8601).

Example:

"2026-06-30"

format
enum<string>
default:json

Export format. json (default) returns a nested array (capped); csv returns a flattened table (capped); ndjson streams one note per line with no row cap.

Available options:
json,
csv,
ndjson
Example:

"json"

Response

The matching notes, in the requested format

data
object[]
required
meta
object
required