Conversations
List Conversations
List inbox conversations
GET
List Conversations
List inbox conversations: replies to your campaigns, sequences and transactional email, plus email sent to your inbox address. Results are sorted by most recent message and can be filtered by status, unread flag, search term, or the inbox address a conversation started at.
Mail that the inbound spam or virus scan flags goes to the Spam folder instead of being dropped. Spam conversations are left out of every list unless you pass
spam=true; move them with Move Conversations to or from Spam.
context.type is campaign, sequence or transactional for replies, inbox (label Inbox) for email sent to the inbox address, and unknown otherwise.
Request
string
Filter by status:
all, open, or closed. Defaults to all.string
Search in subject, subscriber email, or subscriber name.
number
Page number. Defaults to 1.
number
Results per page, from 1 to 100. Defaults to 20.
string
Pass
true to only return conversations with unread messages.string
Pass
true to list the Spam folder instead. false (the default) leaves spam
out. Any other value returns 400.string
Only conversations that started at this inbox address, such as
admin@acme.com. Case does not matter. List Conversation
Recipients returns the addresses you can use.Response fields
boolean
true when the conversation is in the Spam folder.string | null
The inbox address the conversation started at, such as
admin@acme.com.
null for replies to your emails.object | null
A plain-text preview of the latest subscriber or team reply, up to 200 characters. Quoted history, signatures and markup are removed, and internal notes are skipped.
null when no reply has readable text.