Skip to main content
GET
List inbox threads

Authorizations

X-API-Key
string
header
required

Query Parameters

stage
string

Stage key, 'positive' (default) or 'all'. Stages: interested, meeting_request, not_interested, objection, pricing_question, more_info_needed, timing_issue, wrong_person, out_of_office, automated, unsubscribe, unclassified.

campaign_only
string

'1' (default) = campaign replies only; any other value includes non-campaign threads.

exclude_auto
string

'1' (default) hides automated/out-of-office; any other value shows them.

unread
string

'1' = unread only. Default off.

reminders
string

'1' = threads with an open reminder. Default off.

q
string

Substring on sender, subject, snippet, contact email.

mailbox
string

Exact sending mailbox email.

tag
string

Exact thread tag.

campaign
integer

Campaign id.

Response

200

JSON {items:[{thread_id, prospect_email, name, company, title, subject, snippet, last_at, age_days, unread, messages, needs_reply, stage, campaign:{id,name}, mailbox, tags, has_reminder, is_auto}], truncated, filters, counts:{by_stage, positive, all, unread, unread_all, exact}, tags, mailboxes}.