Documentation
Sign inGet started

Get a message in a thread

GET
/v1/email/threads/{thread_id}/messages/{message_id}
curl -X GET "https://us1.platform.bird.com/v1/email/threads/{thread_id}/messages/{message_id}" \
  -H "Authorization: Bearer $TOKEN"
Returns a single message in a conversation, including its extracted plain text. Metadata and extracted text remain readable for the mailbox's retention period; a message that has passed it returns 410 Gone. A message that exists but does not belong to this thread returns 404.
Payload de resposta
id
string
obrigatório
Message ID. Received messages carry a rem_ ID, sent messages an em_ ID — the same IDs used by the received-message and sent-message logs.
direction
string
obrigatório
Direction of the message — inbound for a received message, outbound for a sent one.
Possible values: inbound, outbound
channel
string
obrigatório
Channel this message was carried on. Always email.
thread_id
string
obrigatório
Conversation this message belongs to.
from
string
obrigatório
Sender address.
to
array of string
obrigatório
Recipient addresses on the To line.
cc
array of string
obrigatório
Recipient addresses on the Cc line. Empty when the message had none.
delivered_to
nullable string
obrigatório
Address the message was actually delivered to, when it differs from the mailbox address (for example mail routed in from another address). Null for sent messages and for mail addressed directly to the mailbox.
subject
nullable string
obrigatório
Message subject. Null when the message had no subject.
preview
nullable string
obrigatório
Short plain-text preview of the message body.
extracted_text
nullable string
Plain-text content of the message with quoted history stripped — readable for the mailbox's full retention period, both directions. Always present when fetching a single message; on list endpoints it is included only when the request sets include=extracted_text. Null when no text could be extracted.
labels
array of string
obrigatório
Labels on this message. System labels carry its state: a received message holds exactly one placement label — inbox for accepted mail, archive when its conversation was filed away, spam (failed sender authentication), or blocked (rejected by the mailbox's receive policy or rules) — plus unread until it is read. trash marks a message in the trash, either direction. Custom labels share the same list; a message carries at most 20.
status
nullable string
obrigatório
Folded delivery status of a sent message: accepted, sent (provider handoff), delivered (all attempted recipients delivered), or failed (terminal failure). Null for received messages.
recipients
nullable array
obrigatório
Terminal per-recipient delivery outcomes of a sent message, folded in as they become known — part of the message's durable memory. Null for received messages and before any recipient reaches a terminal state. Per-recipient event detail lives on the sent-message log (source) for 30 days.
authentication
nullable string
obrigatório
Whether the sender of a received message was authenticated. pass means the sender's identity was verified; fail means it was checked and did not verify; unknown means no verdict could be determined and the sender should not be treated as verified. Null for sent messages. Part of the message's durable memory — readable for the mailbox's full retention period, so the verdict survives after the 30-day inbound log has expired.
Possible values: pass, fail, unknown, null
spf_pass
nullable boolean
obrigatório
Whether SPF passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.
dkim_pass
nullable boolean
obrigatório
Whether DKIM passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.
dmarc_pass
nullable boolean
obrigatório
Whether DMARC passed for the sender of a received message. Null for sent messages and when no verdict is available. Durable for the mailbox's retention period.
purge_at
string
obrigatório
When the message will be permanently deleted: the end of the mailbox's retention period, pulled nearer (at most 30 days out) while the message is in the trash. Restore a trashed message before then with PATCH {"labels": {"remove": ["trash"]}}.
attachment_count
integer
obrigatório
Number of attachments on the message.
attachment_manifest
array of object
obrigatório
Attachment metadata (filename, content type, size). Remains readable for the mailbox's retention period even after the attachment bytes themselves have expired.
Mostrar atributos secundários
attachment_manifest.id
string
obrigatório
Attachment ID, used to download the attachment bytes.
attachment_manifest.filename
nullable string
obrigatório
Original filename, or null when the attachment had none.
attachment_manifest.content_type
nullable string
obrigatório
MIME content type, or null when it could not be determined.
attachment_manifest.size
integer
obrigatório
Attachment size in bytes.
reference_ids
array of string
obrigatório
RFC 5322 References header entries used to thread the conversation.
contact_id
nullable string
obrigatório
Contact linked to this message, or null when none is linked.
source
object
obrigatório
Link to the message's entry in the received-message or sent-message log, which carries delivery analytics such as per-recipient events. Log entries expire 30 days after the message occurred.
Mostrar atributos secundários
source.resource
string
obrigatório
API path of the log entry for this message.
source.available_until
string
obrigatório
When the log entry (and the message's original rendered source) expires.
occurred_at
string
obrigatório
When the message was received or accepted for sending.