Get a message
GET
/v1/email/messages/{message_id}
curl -X GET "https://us1.platform.bird.com/v1/email/messages/{message_id}" \
-H "Authorization: Bearer $TOKEN"Returns a single email message object with aggregate delivery status and counts. Message body (html, text) is not returned — it is not stored after delivery.
Paramètres
message_id
string
Message ID.
Contenu de la réponse
id
string
obligatoire
Message ID.
from
object
obligatoire
Sender address. name is present when a display name was provided on the send.
Afficher les attributs enfants
from.email
string
obligatoire
Email address.
from.name
string
Display name shown alongside the address in mail clients.
to
array of object
obligatoire
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.
Afficher les attributs enfants
to.email
string
obligatoire
Email address.
to.name
string
Display name shown alongside the address in mail clients.
cc
array of object
CC recipients.
Afficher les attributs enfants
cc.email
string
obligatoire
Email address.
cc.name
string
Display name shown alongside the address in mail clients.
bcc
array of object
BCC recipients.
Afficher les attributs enfants
bcc.email
string
obligatoire
Email address.
bcc.name
string
Display name shown alongside the address in mail clients.
subject
string
obligatoire
Message subject line.
category
string
obligatoire
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
obligatoire
Aggregate delivery status derived from recipient states. scheduled means the message is queued to send at a future time and has not been dispatched yet. 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. canceled means a scheduled message was canceled before it was sent.
accepted_count
integer
obligatoire
Number of recipients currently in the accepted state — Bird has the send and is preparing to deliver.
processed_count
integer
obligatoire
Number of recipients for whom Bird has processed the message and queued it for delivery.
delivered_count
integer
obligatoire
Number of recipients whose messages were accepted by the remote MTA.
bounced_count
integer
obligatoire
Number of recipients that resulted in a permanent delivery failure.
complained_count
integer
obligatoire
Number of recipients that reported spam.
deferred_count
integer
obligatoire
Number of recipients in transient delivery deferral; the provider is retrying.
rejected_count
integer
obligatoire
Number of recipients rejected before delivery. See the per-recipient rejection_reason field on GET /v1/email/messages/{message_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
obligatoire
Total open events across all recipients.
click_count
integer
obligatoire
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.
Afficher les attributs enfants
tags.name
string
obligatoire
Tag name. ASCII letters, digits, underscore, and hyphen only. Case-sensitive. Maximum 32 characters.
tags.value
string
obligatoire
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.
Afficher les attributs enfants
attachments.id
string
Attachment ID, stable per email send.
attachments.filename
string
obligatoire
Filename as shown to the recipient.
attachments.content_type
string
Resolved MIME type at send time.
attachments.size
integer
obligatoire
Decoded size in bytes.
attachments.inline
boolean
True when the attachment was sent inline via a content_id reference in the HTML body, false for regular file attachments.
attachments.content_id
nullable string
The Content-ID set at send time, when the attachment was inline.
track_opens
boolean
obligatoire
Whether open tracking is enabled for this send.
track_clicks
boolean
obligatoire
Whether click tracking is enabled for this send.
created_at
string
obligatoire
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.
scheduled_at
nullable string
When this message is scheduled to send, for a send created with a future send time. Null for an immediate send. Stays set after the scheduled send fires.