Skip to main content
GET
List Email Threads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
category
enum<string> | null

Filter threads by category: drafts, unread, sent, or all.

Available options:
all,
drafts,
sent,
unread
partner_id
string | null

Filter threads by partner ID.

invoice_id
string | null

Filter threads by invoice ID.

workflow_id
string | null

Filter threads by workflow ID.

business_unit_id__in
string[] | null

Filter threads by business unit IDs. Independent of the user's BU visibility scope, which is always enforced.

assignee
string | null

Filter by partner assignee user ID. Empty string filters to unassigned threads.

has_responses
boolean | null

True: threads with more than one email; False: single-email threads.

read
boolean | null

True: no unread inbound emails; False: at least one unread inbound email.

has_open_tasks
boolean | null

Filter threads by whether they have any open tasks.

triage_status
enum<string> | null

Filter to threads in a specific triage state. Takes precedence over is_triaged and triaged_by__in.

Available options:
pending,
auto_matched,
manually_matched,
dismissed
is_triaged
boolean | null

True: AUTO_MATCHED or MANUALLY_MATCHED; False: PENDING. Ignored when triage_status is set.

triaged_by__in
string[] | null

Filter resolved triage threads by the actor that resolved them. Use TRIAGE_AI_ACTOR_ID for AI-resolved.

is_from_centralized_inbox
boolean | null

Filter threads to those from (or not from) the centralized inbox.

is_internal
boolean | null

True: show only internal-to-internal threads (every address on every email belongs to the org). When True, bypasses the default partner_id requirement since internal threads have no partner. False/None: existing behavior.

search
string | null

Search threads by partner name or email.

Response

Successful Response

data
EmailThreadSummary · object[]
required

The list of records.

current_page
integer
default:0
required

The current page.

total_records
integer | null
required

Total number of records.

Required range: x >= 0
next_page
integer | null
required

The next page number, if one exists.