Get a mailbox
GET
/v1/email/mailboxes/{mailbox_id}
curl -X GET "https://us1.platform.bird.com/v1/email/mailboxes/{mailbox_id}" \
-H "Authorization: Bearer $TOKEN"Returns a single mailbox by ID.
Contenu de la réponse
id
string
obligatoire
Mailbox ID.
address
string
obligatoire
The mailbox's email address. Immutable once created.
display_name
nullable string
obligatoire
Display name used as the sender name on mail from this mailbox. Null when unset.
default_reply_to
nullable string
obligatoire
Default Reply-To address stamped on mail sent from this mailbox. Null when unset.
receive_policy
string
obligatoire
Which inbound mail the mailbox accepts. open accepts everything not blocked by a rule; replies_only accepts only replies to messages this mailbox has sent (a reply must match a message the mailbox sent, not merely land in an existing thread); allowlist accepts only senders matching an allow rule (replies to prior outbound are always admitted unless blocked); drop stores nothing.
state
string
obligatoire
Lifecycle state. Suspended mailboxes stop emitting events; inbound mail is retained as blocked.
channel
string
obligatoire
The channel this mailbox receives on. Always email.
owner
object
obligatoire
The principal that owns the mailbox. Always the workspace.
Afficher les attributs enfants
owner.type
string
obligatoire
Owner principal type.
owner.id
string
obligatoire
Owner principal ID.
contact_id
nullable string
obligatoire
The contact this mailbox is associated with. Null when unset.
inbound_address_id
string
obligatoire
The underlying inbound address that receives this mailbox's mail.
storage_bytes
integer
obligatoire
Logical size of the mailbox's retained memory, in bytes.
retention_tier
string
obligatoire
How long the mailbox remembers message metadata and extracted text. Original rendered source (HTML, raw message, attachments) is always available for 30 days regardless of tier. 3y and 10y are reserved future tiers.
message_count
integer
obligatoire
Number of retained messages across all threads.
thread_count
integer
obligatoire
Number of retained threads.
metadata
object
obligatoire
Your own key/value data attached to the mailbox. Up to 2 KB; keys starting with __bird are reserved.
created_at
string
obligatoire
When the mailbox was created.
updated_at
string
obligatoire
When the mailbox was last updated.