List messages
GET
/v1/email/messages
Returns a paginated list of email messages in the workspace, newest first.
Paramètres de requête
limit
integer
Maximum number of items to return per page.
starting_after
string
Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_before
string
Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order.
created_after
string
Return only resources created strictly after this timestamp. RFC 3339 / ISO 8601 with timezone.
created_before
string
Return only resources created strictly before this timestamp. RFC 3339 / ISO 8601 with timezone.
status
string
Filter by aggregate delivery status.
tag
string
Filter by tag. Accepts name to match any send carrying that tag name, or name:value to match a specific tag pair (e.g. category:welcome). For filtering on arbitrary metadata fields, use the metadata path-filter parameters instead.
category
string
Filter by category.
to
string
Filter by recipient address. Exact match against any to/cc/bcc recipient on the message; normalised to lowercase before comparison.
from
string
Filter by sender address. Exact match against the message from field; normalised to lowercase before comparison.
Response Payload
data
array of object
required
Page of message objects.
Show child attributes
id
string
required
Message ID.
from
object
required
Sender address. name is present when a display name was provided on the send.
Show child attributes
email
string
required
Email address.
name
string
Display name shown alongside the address in mail clients.
to
array of object
required
Primary recipients. Length is the recipient count; use the broadcasts endpoint for audience-targeted sends. Each entry's name is present when a display name was provided on the send.
Show child attributes
email
string
required
Email address.
name
string
Display name shown alongside the address in mail clients.
cc
array of object
CC recipients.
Show child attributes
email
string
required
Email address.
name
string
Display name shown alongside the address in mail clients.
bcc
array of object
BCC recipients.
Show child attributes
email
string
required
Email address.
name
string
Display name shown alongside the address in mail clients.
subject
string
required
Message subject line.
category
string
required
Content classification. Controls suppression policy — marketing blocks on all suppression reasons; transactional allows delivery through complaint and unsubscribe suppressions.
reply_to
nullable array
Reply-To addresses, if set on the send. Empty/null when no Reply-To was provided.
status
string
required
Aggregate delivery status derived from recipient states. accepted means Bird has the send and is preparing to deliver. processed means Bird has processed the message and queued it for delivery to the recipient's mail server.
accepted_count
integer
required
Number of recipients currently in the accepted state — Bird has the send and is preparing to deliver.
processed_count
integer
required
Number of recipients for whom Bird has processed the message and queued it for delivery.
delivered_count
integer
required
Number of recipients whose messages were accepted by the remote MTA.
bounced_count
integer
required
Number of recipients that resulted in a permanent delivery failure.
complained_count
integer
required
Number of recipients that reported spam.
deferred_count
integer
required
Number of recipients in transient delivery deferral; the provider is retrying.
rejected_count
integer
required
Number of recipients rejected before delivery. See the per-recipient rejection_reason field on GET /v1/emails/{id}/recipients for the specific cause (suppression match, transmission failure, generation failure, or policy refusal).
processing_latency_ms
nullable integer
Time between Bird accepting the send and the message being processed for delivery, in milliseconds, for the fastest recipient. Null until the first recipient reaches processed.
delivery_latency_ms
nullable integer
Time between the message being processed and the receiving mail server accepting it, in milliseconds, for the fastest delivered recipient. Null until the first recipient is delivered.
total_latency_ms
nullable integer
End-to-end accept → delivered time for the fastest delivered recipient, in milliseconds. Null until the first recipient is delivered.
open_count
integer
required
Total open events across all recipients.
click_count
integer
required
Total click events across all recipients.
tags
array of object
Structured {name, value} filter labels applied to this send. See EmailMessageSendRequest for the tags vs metadata distinction.
Show child attributes
name
string
required
Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
value
string
required
Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.
metadata
object
Arbitrary JSON metadata stored on the message object and echoed in webhook payloads. See EmailMessageSendRequest for the tags vs metadata distinction.
attachments
array of object
Attachment metadata for the send. Empty when no attachments were included. Raw content is not echoed; use the future content-retrieval endpoint when storage is enabled.
Show child attributes
id
string
Attachment ID, stable per email send.
filename
string
required
Filename as shown to the recipient.
content_type
string
Resolved MIME type at send time.
size
integer
required
Decoded size in bytes.
inline
boolean
True when the attachment was sent inline via a content_id reference in the HTML body, false for regular file attachments.
content_id
nullable string
The Content-ID set at send time, when the attachment was inline.
track_opens
boolean
required
Whether open tracking is enabled for this send.
track_clicks
boolean
required
Whether click tracking is enabled for this send.
created_at
string
required
When the send request was accepted.
thread_id
nullable string
Thread this message belongs to. Null until threading is enabled.
in_reply_to_message_id
nullable string
The message this one is a reply to, if any.
delivered_at
nullable string
When all recipients reached a terminal delivered state, or null if not yet fully delivered.
next_cursor
nullable string
required
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
required
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
required
Refresh anchor. Pass back as ending_before later to fetch items that have appeared since this response. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
cURL
curl -X GET "https://us1.platform.bird.com/v1/email/messages" \
-H "Authorization: Bearer $TOKEN" \
--url-query "limit=25"