prawnwire Developers

Messages

List the organization's outbound messages, newest first.

GET/v1/messages/outbound

Authentication

Use an API key with email:read. Results belong to the key’s organization. Test submissions are never stored in activity.

Query parameters

Every parameter is optional. Filters combine with AND.

ParameterType and defaultMeaning
countinteger, 50Page size from 1 to 500.
offsetinteger, 0Records to skip, from 0 to 10,000. count + offset must not exceed 10,000.
recipientstringExact recipient address, case-insensitive. Includes To, Cc and Bcc.
fromemailstringExact sender address, case-insensitive. Supply an address, not a display-name string.
tagstringExact tag match.
statusstringqueued, sent, failed, or processed. Values are case-insensitive; processed means sent.
subjectstringCase-insensitive substring match. SQL wildcard characters % and _ retain their wildcard meaning.
fromdatedate or timestampInclusive lower bound on submission time.
todatedate or timestampInclusive upper bound on submission time.

Dates can be 2026-10-01 or ISO-style timestamps such as 2026-10-01T09:30:00Z. A timestamp without a zone is treated as UTC. A bare todate includes that entire UTC day. Encode query values when building a URL.

Invalid pagination, status, or date input returns ErrorCode 300, HTTP 422. Recipient statuses such as bounced are not valid message-status filters.

Response

TotalCount is the number of matching messages, not just the current page. Messages contains summaries. Increase offset by the page size to read another page; use date filters to narrow searches beyond the 10,000-record window.

Summary fieldMeaning
MessageID, ReceivedAtUUID and submission timestamp.
From, Subject, Tag, MetadataSender and application context.
To, Cc, BccArrays of { Email, Name }; Name may be null.
RecipientsAddress strings for all recipient kinds, including suppressed recipients.
StatusQueued, Sent, or Failed. Internal sending also renders as Queued.
AttachmentsFilename strings, not contents.
MessageStreamAlways outbound.
TrackOpens, TrackLinks, Sandboxedfalse, "None", and false. Test sends are not stored.

Read delivery information

A message’s Sent status is not a recipient delivery receipt. Fetch message details and inspect MessageEvents for recipient results.

Search documentation

Type to search the documentation.