Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

List messages

GET
/v1/email/messages
for await (const message of bird.email.list({ status: "bounced" })) {
  console.log(message.id);
}
Response200
{
  "data": [
    {
      "id": "em_01krdgeqcxet5s7t44vh8rt9mg",
      "from": {
        "email": "onboarding@messagebird.dev",
        "name": "Bird"
      },
      "to": [
        {
          "email": "delivered@messagebird.dev"
        }
      ],
      "subject": "Hello from Bird",
      "category": "marketing",
      "status": "accepted",
      "broadcast_id": "eb_01krdgeqcxet5s7t44vh8rt9mg",
      "accepted_count": 1,
      "processed_count": 0,
      "delivered_count": 0,
      "bounced_count": 0,
      "complained_count": 0,
      "deferred_count": 0,
      "rejected_count": 0,
      "open_count": 0,
      "click_count": 0,
      "track_opens": false,
      "track_clicks": false,
      "created_at": "2026-07-01T12:00:00Z"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "prev_cursor": null,
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Returns the workspace's sent and scheduled messages, newest first, as a cursor page. Each item has the aggregate delivery status and per-state recipient counts. Message bodies are omitted.

Combine filters to narrow the page:

  • Delivery status.
  • Category.
  • Tag.
  • An exact to or from address.
  • A created_after or created_before time window.

Query Parameters

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

created_afterstring

Limits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset.

created_beforestring

Limits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset.

statusstring

Filter by aggregate delivery status.

Possible values: scheduled, accepted, processed, deferred, delivered, partial_failure, bounced, complained, rejected, canceled

tagarray

Filter by tag. Accepts name to match any record carrying that tag name, or name:value to match a specific tag pair (for example category:welcome). Repeat the parameter to add more tags. A record must match every tag listed to be returned.

categorystring

Filter by category.

Possible values: marketing, transactional

tostring

Filter by recipient address. Exact match against any to/cc/bcc recipient on the message. The address is normalized to lowercase before comparison.

fromstring

Filter by sender address. Exact match against the message from field. The address is normalized to lowercase before comparison.

Response Payload

data
array of object
required

Page of message objects.

Show child attributes
data.id
string
required

Message ID.

data.from
object
required

Sender address. name is present when a display name was provided on the send.

Show child attributes
data.from.email
string
required

Email address.

data.from.name
string

Display name shown alongside the address in mail clients.

data.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
data.to.email
string
required

Email address.

data.to.name
string

Display name shown alongside the address in mail clients.

data.cc
array of object

CC recipients.

Show child attributes
data.cc.email
string
required

Email address.

data.cc.name
string

Display name shown alongside the address in mail clients.

data.bcc
array of object

BCC recipients.

Show child attributes
data.bcc.email
string
required

Email address.

data.bcc.name
string

Display name shown alongside the address in mail clients.

data.subject
string
required

The subject line as delivered. For a send that used a template, the stored subject is the template's, so this reports it with the send's parameters substituted in, which is what the recipient saw.

data.category
string
required

Content classification, which controls suppression policy:

  • marketing: Blocks on all suppression reasons.
  • transactional: Allows delivery through complaint and unsubscribe suppressions, for receipts, password resets, and similar operational mail.

Possible values: marketing, transactional

data.reply_to
nullable array

Reply-To addresses, if set on the send. Empty/null when no Reply-To was provided.

data.status
string
required
data.accepted_count
integer
required

How many recipients are in the accepted state, meaning we have the message and are getting ready to deliver it.

data.processed_count
integer
required

How many recipients the message has been prepared for and queued for delivery.

data.delivered_count
integer
required

How many recipients' messages were accepted by their mail server.

data.bounced_count
integer
required

Number of recipients that resulted in a permanent delivery failure.

data.complained_count
integer
required

Number of recipients that reported spam.

data.deferred_count
integer
required

Number of recipients in transient delivery deferral. Their mail server asked for a retry, and delivery attempts continue.

data.rejected_count
integer
required

Number of recipients rejected before delivery. Read the per-recipient rejection_reason field on GET /v1/email/messages/{message_id}/recipients for the specific cause.

data.processing_latency_ms
nullable integer

Time between the send being accepted and the message being prepared for delivery, in milliseconds, for the fastest recipient. Null until the first recipient reaches processed.

data.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.

data.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.

data.open_count
integer
required

Total open events across all recipients.

data.click_count
integer
required

Total click events across all recipients.

data.requested_language
nullable string

The template language this send asked for, in canonical form (pt-BR for a request of pt-br). Null when the send named no language (it took the template's default) or used no template at all. Compare it with resolved_language: when they differ, the language you asked for was not available and the template's on_missing_language policy chose the one shown there instead.

data.resolved_language
nullable string

The template language this send was actually delivered in, in canonical form. Null when the send used no template. A non-null value with a null requested_language means the send named no language and took the template's default.

data.template_id
nullable string

The template this send rendered from, or null for a send that supplied its content inline.

data.template_version_id
nullable string

The exact template version this send rendered from, or null for an inline send. A template's live version changes every time you submit it, so this is what identifies the wording that was actually delivered, together with resolved_language.

data.broadcast_id
string

The broadcast that sent this message. Absent for a send that was not part of a broadcast. A broadcast records one message per recipient, and every one of them carries the same value here.

data.tags
array of object

Labels on this message, each one a name and a value, that you can filter and search messages by. Use tags for anything you want to find messages by later, and metadata for data you only want handed back to you.

Show child attributes
data.tags.name
string
required

Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.

data.tags.value
string
required

Tag value. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 64 characters.

data.metadata
object

Any JSON you kept on the message. We store it and hand it back in webhook payloads, and that is all it does. If you want to search or filter by it, use tags instead.

data.parameters
nullable object

The substitution values this send supplied, whether inline or from a template, or null if none were supplied. They are the values applied to subject and to the bodies the content endpoint returns, kept so you can see what produced the delivered copy and not only the result.

data.attachments
array of object

Attachment metadata for the send. Empty when no attachments were included. Raw content is not echoed. When content storage is enabled, download an attachment by its id via the message's attachment endpoint.

Show child attributes
data.attachments.id
string

Attachment ID, stable per email send.

data.attachments.filename
string
required

Filename as shown to the recipient.

data.attachments.content_type
string

Resolved MIME type at send time.

data.attachments.size
integer
required

Decoded size in bytes.

data.attachments.inline
boolean

True when the attachment was sent inline via a content_id reference in the HTML body, false for regular file attachments.

data.attachments.content_id
nullable string

The Content-ID set at send time, when the attachment was inline.

data.track_opens
boolean
required

Whether open tracking is enabled for this send.

data.track_clicks
boolean
required

Whether click tracking is enabled for this send.

data.created_at
string
required

When the send request was accepted.

data.thread_id
nullable string

Thread this message belongs to, or null when the message is not part of one.

data.in_reply_to_message_id
nullable string

The message this one is a reply to, if any.

data.delivered_at
nullable string

When all recipients reached a terminal delivered state, or null if not yet fully delivered.

data.scheduled_at
string

When this message is scheduled to send, for a send created with a future send time. Absent for an immediate send. Stays set after the scheduled send fires.

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, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Related resources

Continue with the documentation, guides and examples for this topic.

Try the practice and get an implementation brief