Skip to main content
GET
List Threads

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

folder
enum<string>
default:INBOX

Virtual folder to filter by

Available options:
INBOX,
SENT,
DRAFTS,
STARRED,
ARCHIVED,
ALL
per_page
integer
default:50
Required range: 1 <= x <= 100
cursor
string | null

Cursor for pagination

search
string | null

Search in subject and snippet

before_date
string<date-time> | null
after_date
string<date-time> | null
include_all_system_emails
boolean
default:false

Include all system emails (requires messaging:emails:read_all permission)

scope
enum<string>
default:provider

Thread scope: provider for current-user threads, clinic for the shared tenant mailbox

Available options:
provider,
clinic
triage
boolean
default:false

Triage lens: unread OR awaiting-reply OR starred

unread
boolean
default:false

Only unread threads

starred
boolean
default:false

Only starred threads

has_patient
boolean
default:false

Only threads linked to a patient

has_attachment
boolean
default:false

Only threads with an attachment

group_by_patient
boolean
default:false

By-patient lens: section threads by linked patient (implies has_patient)

Response

Successful Response

data
EmailThreadListItem · object[]
required
total
integer
required
nextCursor
string | null