Sign in

v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Practice Management

Retrieve or search message threads in doctor's message center. (beta)

Message threads are grouped conversations that aggregate related messages by subject and patient. Use this endpoint to display an inbox-style view of conversations.

Work to support message threads is currently in development. This is not ready for full use.

get/api/message_threads

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

doctorinteger

Filter by doctor ID

practice_groupinteger

Filter by practice group ID

patientinteger

Filter by patient ID

message_typestring

Filter by message type (e.g., "GP", "GC", "MC", "IF", "OF", etc.)

archivedboolean

Filter by archived status (true/false)

starredboolean

Filter by starred status (true/false)

unread_countinteger

Filter threads with unread messages (pass any positive integer to get threads with unread_count > 0)

updated_sincestring

Filter by threads updated since this datetime (ISO 8601 format)

Response

OK

previousstring nullable

Previous paginated page

nextstring nullable

Next Paginated page