List received emails
GET
/v1/email/inbound-messages
curl -X GET "https://us1.platform.bird.com/v1/email/inbound-messages" \
-H "Authorization: Bearer $TOKEN" \
--url-query "from=alice@example.com" \
--url-query "limit=25"Returns a paginated list of received emails for the workspace, newest first. Filter by sender address, by the inbound address that received the mail, or by a received-time range.
Parámetros de consulta
from
string
Filter to messages whose sender address matches this value.
inbound_address_id
string
Filter to messages received on a specific Bird-minted inbound address.
received_after
string
Filter to messages received at or after this time.
received_before
string
Filter to messages received at or before this time.
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.
Carga de respuesta
data
array of object
obligatorio
Mostrar atributos secundarios
data.id
string
obligatorio
Received message ID.
data.from
object
obligatorio
Sender address parsed from the message.
Mostrar atributos secundarios
data.from.email
string
obligatorio
Email address.
data.from.name
string
Display name shown alongside the address in mail clients.
data.to
array of object
obligatorio
Recipients on the message's To header.
Mostrar atributos secundarios
data.to.email
string
obligatorio
Email address.
data.to.name
string
Display name shown alongside the address in mail clients.
data.cc
array of object
obligatorio
Recipients on the message's Cc header.
Mostrar atributos secundarios
data.cc.email
string
obligatorio
Email address.
data.cc.name
string
Display name shown alongside the address in mail clients.
data.subject
nullable string
obligatorio
Subject line as received, or null when the message had no subject.
data.message_id
nullable string
obligatorio
RFC 5322 Message-ID header from the sender, or null when the sender did not include one.
data.in_reply_to
nullable string
obligatorio
In-Reply-To header — the Message-ID this message replies to, or null when it is not a reply.
data.references
array of string
References header — the chain of Message-IDs in this conversation, oldest first. Absent when the message had no References header.
data.thread_id
nullable string
obligatorio
Conversation this message belongs to. Always null until threading is available.
data.spf_pass
nullable boolean
obligatorio
Whether SPF passed for the sender, parsed from the message's authentication results. Null when the result did not carry an SPF verdict.
data.dkim_pass
nullable boolean
obligatorio
Whether DKIM passed for the sender, parsed from the message's authentication results. Null when the result did not carry a DKIM verdict.
data.dmarc_pass
nullable boolean
obligatorio
Whether DMARC passed for the sender, parsed from the message's authentication results. Null when the result did not carry a DMARC verdict.
data.spam_score
nullable number
obligatorio
Spam score for the message. Always null at present; reserved for a future content-scoring capability.
data.attachments
array of object
obligatorio
Metadata for each attachment found on the message. Empty when the message had no attachments.
Mostrar atributos secundarios
data.attachments.id
string
obligatorio
Attachment ID, stable within the received message.
data.attachments.filename
nullable string
obligatorio
Filename from the attachment's Content-Disposition, or null when the sender did not name the part.
data.attachments.content_type
nullable string
obligatorio
MIME type parsed from the attachment part, or null when absent.
data.attachments.size
integer
obligatorio
Size of the attachment in bytes.
data.received_at
string
obligatorio
When Bird received the message.
next_cursor
nullable string
obligatorio
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obligatorio
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obligatorio
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.