Get messages 1
Authorizations
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Query Parameters
Opaque cursor from a previous response to fetch the next page
^[cC][^\s-]{8,}$Maximum number of items to return per page (1–100, default 20)
1 <= x <= 100Filter messages by agent ID
^[cC][^\s-]{8,}$Filter messages by conversation thread ID
^[cC][^\s-]{8,}$Filter messages by communication channel
EMAIL, SMS, MMS, VOICE Filter messages by several channels at once, e.g. SMS+MMS to see a full text conversation. Takes precedence over channel. A single value (?channels=SMS) is accepted as well as the repeated (?channels=SMS&channels=MMS) and bracketed (?channels[]=SMS) forms.
50Communication channel used for the message
EMAIL, SMS, MMS, VOICE Filter messages by direction (inbound or outbound)
INBOUND, OUTBOUND Filter messages by delivery status
QUEUED, SENT, DELIVERED, FAILED, BOUNCED, BLOCKED, PENDING_APPROVAL Filter messages within a date range
Filter to one inbox — messages delivered to it (inbound) or sent from it (outbound). The precise way to read a single mailbox when an agent owns several.
^[cC][^\s-]{8,}$Filter by sender address, matched exactly (case-sensitive). On inbound mail this is the counterparty; on outbound it is the agent identity the mail was sent from.
Filter by recipient address, matched exactly (case-sensitive). Note that outbound messages store every recipient in one comma-joined value, so an exact filter matches a multi-recipient send only when given that same joined string — prefer inboxId to scope outbound mail to a mailbox.
Filter to messages carrying ALL of these labels (e.g. urgent + unread means urgent AND still unread). Case-insensitive. System labels: unread, read, archived, spam.
501 - 64Include messages classified as spam on arrival. They are excluded by default. Naming spam in labels also counts as asking for it, so a deliberate spam query is never silently emptied by this default.
Include messages carrying the archived label. They are excluded by default, so archiving actually removes mail from a listing rather than only tagging it. Naming archived in labels also counts as asking for it (and returns ONLY archived mail); use this flag instead to see archived mail mixed in with the rest.
How to treat messages moved to Trash. exclude (default) hides them, so deleted mail disappears from every ordinary listing. only returns nothing but Trash. include ignores the distinction. Deletion is reversible — see DELETE /messages/{id} and POST /messages/{id}/restore.
exclude, include, only 