Skip to main content
GET
Count inbox threads

Authorizations

X-API-Key
string
header
required

Query Parameters

view
string
default:all

Which reading of the inbox to list

Pattern: ^(all|unlabelled|needs_approval|bounces|reminders|sent|all_mail)$
unread_only
boolean
default:false

Only conversations nobody has read

reply_state
enum<string> | null

Only answered, or only unanswered Whether the contact's latest reply has had an answer from us.

A filter over the working inbox, where every conversation is one the contact answered. REPLIED: an answer of ours went out after their latest reply, written by a person or by the agent. A LinkedIn reply queued for the browser counts once nothing waits on a person's approval for it (a person sent it, or its task was approved); one still waiting on Tasks, a failed one and a forward to somebody else do not. NOT_REPLIED: their latest reply is still the last word. Only a genuine reply asks for an answer, so an auto-reply or a bounce arriving after our answer leaves a conversation REPLIED, and a thread whose only inbound mail is automatic is no conversation at all: the inbox does not list it, so neither state does.

Available options:
replied,
not_replied
sequence_id
string<uuid> | null

Only this sequence's conversations

mailbox_id
string<uuid> | null

Only this mailbox's conversations

sender_profile_id
string<uuid> | null

Only this sender's conversations

sequence_id__not
string<uuid>[] | null

Leave out these sequences' conversations

Maximum array length: 100
mailbox_id__not
string<uuid>[] | null

Leave out these mailboxes' conversations

Maximum array length: 100
sender_profile_id__not
string<uuid>[] | null

Leave out these senders' conversations

Maximum array length: 100
label_id
string<uuid> | null

Only conversations carrying this label

channel
enum<string> | null

Only email, or only LinkedIn Which surface a conversation happens on.

Threads are contact-scoped, not channel-scoped, so this says how a thread is REACHED rather than partitioning the inbox: a reply arrives, is classified and stops the cadence identically either way, and only the send path differs.

Available options:
email,
linkedin
last_message_at__after
string<date-time> | null

Only conversations whose last message is at or after this time

last_message_at__before
string<date-time> | null

Only conversations whose last message is at or before this time

search
string | null

Full-text search over every message and the contact's name and address

Maximum string length: 255

Response

Successful Response

count
integer
required