bird email mailboxes list
Usage
Code example
bird email mailboxes list [flags]Description
List the workspace's mailboxes as a cursor page, newest first. Search addresses and display names with q, or filter by exact address, state, or domain.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird email mailboxes list
bird email mailboxes list | jq -r '.data[].id'
bird email mailboxes list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
--address | Filter to the mailbox with exactly this address. |
--domain | Filter to mailboxes whose address is on this domain. |
--include-deleted | Include mailboxes deleted within their 30-day restore window. Defaults to false, so only active and suspended mailboxes are returned. A deleted mailbox has deleted_at set. |
--q | Case-insensitive search matching the mailbox's address or display name (substring). |
--response-schema | Print the fields this command returns, then exit |
--state | Return only active or suspended mailboxes. Use include_deleted for restorable deleted mailboxes. Possible values: active, suspended. |
Pagination
| Name | Description |
|---|---|
--ending-before | Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. |
--limit <n> | Maximum number of items to return per page. Allowed range: 1 to 100. |
--starting-after | Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order. |
Related
| Name | Description |
|---|---|
bird email mailboxes compose | Send a new message from a mailbox |
bird email mailboxes create | Create a mailbox |
bird email mailboxes delete | Delete a mailbox |
bird email mailboxes get | Get a mailbox |
bird email mailboxes labels | List a mailbox's labels |
bird email mailboxes restore | Restore a deleted mailbox |
bird email mailboxes resume | Resume a suspended mailbox |
bird email mailboxes stats | Get mailbox email statistics |
bird email mailboxes update | Update a mailbox |
Related resources
Continue with the documentation, guides and examples for this topic.