List mailboxes
GET
/v1/email/mailboxes
curl -X GET "https://us1.platform.bird.com/v1/email/mailboxes" \
-H "Authorization: Bearer $TOKEN" \
--url-query "address=concierge@acme-support.eu.mailbox.bird.com" \
--url-query "domain=acme-support.eu.mailbox.bird.com" \
--url-query "limit=25"Returns a paginated list of the workspace's mailboxes, newest first. Filter by exact address (to look a mailbox up by its email address), by lifecycle state, or by domain.
Parametry zapytania
address
string
Filter to the mailbox with exactly this address.
state
string
Filter by lifecycle state.
domain
string
Filter to mailboxes whose address is on this domain.
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.
Treść odpowiedzi
data
array of object
wymagane
Pokaż atrybuty podrzędne
data.id
string
wymagane
Mailbox ID.
data.address
string
wymagane
The mailbox's email address. Immutable once created.
data.display_name
nullable string
wymagane
Display name used as the sender name on mail from this mailbox. Null when unset.
data.default_reply_to
nullable string
wymagane
Default Reply-To address stamped on mail sent from this mailbox. Null when unset.
data.receive_policy
string
wymagane
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.
data.state
string
wymagane
Lifecycle state. Suspended mailboxes stop emitting events; inbound mail is retained as blocked.
data.channel
string
wymagane
The channel this mailbox receives on. Always email.
data.owner
object
wymagane
The principal that owns the mailbox. Always the workspace.
Pokaż atrybuty podrzędne
data.owner.type
string
wymagane
Owner principal type.
data.owner.id
string
wymagane
Owner principal ID.
data.contact_id
nullable string
wymagane
The contact this mailbox is associated with. Null when unset.
data.inbound_address_id
string
wymagane
The underlying inbound address that receives this mailbox's mail.
data.storage_bytes
integer
wymagane
Logical size of the mailbox's retained memory, in bytes.
data.retention_tier
string
wymagane
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.
data.message_count
integer
wymagane
Number of retained messages across all threads.
data.thread_count
integer
wymagane
Number of retained threads.
data.metadata
object
wymagane
Your own key/value data attached to the mailbox. Up to 2 KB; keys starting with __bird are reserved.
data.created_at
string
wymagane
When the mailbox was created.
data.updated_at
string
wymagane
When the mailbox was last updated.
next_cursor
nullable string
wymagane
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
wymagane
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
wymagane
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.