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@inbox.ai" \
--url-query "q=concierge" \
--url-query "domain=inbox.ai" \
--url-query "include_deleted=false" \
--url-query "limit=25"Returns a paginated list of the workspace's mailboxes, newest first. Search across addresses and display names with q, look a mailbox up by its exact address, or filter by lifecycle state or domain.
Parametri di query
address
string
Filter to the mailbox with exactly this address.
q
string
Case-insensitive search matching the mailbox's address or display name (substring).
state
string
Filter by lifecycle state.
Possible values: active, suspended
domain
string
Filter to mailboxes whose address is on this domain.
include_deleted
boolean
Include mailboxes deleted within their 30-day restore window. Defaults to false, so only active and suspended mailboxes are returned. Deleted mailboxes carry a non-null deleted_at.
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.
Payload di risposta
data
array of object
obbligatorio
Mostra attributi secondari
data.id
string
obbligatorio
Mailbox ID.
data.address
string
obbligatorio
The mailbox's email address. Immutable once created.
data.display_name
nullable string
obbligatorio
Display name used as the sender name on mail from this mailbox. Null when unset.
data.default_reply_to
nullable string
obbligatorio
Default Reply-To address stamped on mail sent from this mailbox. Null when unset.
data.receive_policy
string
obbligatorio
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.
Possible values: open, replies_only, allowlist, drop
data.state
string
obbligatorio
Lifecycle state. Suspended mailboxes stop emitting events; inbound mail is retained as blocked.
Possible values: active, suspended
data.channel
string
obbligatorio
The channel this mailbox receives on. Always email.
Possible values: email
data.owner
object
obbligatorio
The principal that owns the mailbox. Always the workspace.
Mostra attributi secondari
data.owner.type
string
obbligatorio
Owner principal type.
Possible values: workspace
data.owner.id
string
obbligatorio
Owner principal ID.
data.inbound_address_id
string
obbligatorio
The underlying inbound address that receives this mailbox's mail.
data.retention_tier
string
obbligatorio
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.
Possible values: 30d, 90d, 1y
data.message_count
integer
obbligatorio
Number of retained messages across all threads.
data.thread_count
integer
obbligatorio
Number of retained threads.
data.unread_thread_count
nullable integer
Number of threads with unread messages in this mailbox, excluding trash. Null on create/update responses.
data.metadata
object
obbligatorio
Your own key/value data attached to the mailbox. Up to 2 KB; keys starting with __bird are reserved.
data.local_part_generated
boolean
Whether Bird generated the local part of the address. false means a custom handle was chosen at creation; on the shared inbox.ai domain a custom handle counts against your plan's custom-handle allowance.
data.created_at
string
obbligatorio
When the mailbox was created.
data.updated_at
string
obbligatorio
When the mailbox was last updated.
data.deleted_at
nullable string
When the mailbox was deleted, or null if it is active. A deleted mailbox stops receiving mail immediately but can be restored for 30 days, after which it and its remembered messages are permanently removed.
next_cursor
nullable string
obbligatorio
Cursor for the next page. Pass back as starting_after to advance forward. Null when no next page exists.
prev_cursor
nullable string
obbligatorio
Cursor for the previous page. Pass back as ending_before to step backward. Null when no previous page exists.
refresh_cursor
nullable string
obbligatorio
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.