email-mailboxes

List mailboxes

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.

get/v1/email/mailboxes

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/mailboxes
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

addressstring email

Filter to the mailbox with exactly this address.

qstring

Case-insensitive search matching the mailbox's address or display name (substring).

state'active' | 'suspended'

Return only active or suspended mailboxes. Use include_deleted for restorable deleted mailboxes.

domainstring

Filter to mailboxes whose address is on this domain.

include_deletedboolean

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.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

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.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of mailboxes.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "mbx_01krdgeqcxet5s7t44vh8rt9mg",
      "address": "concierge@inbox.ai",
      "forwarding_address": "k7q2mzxw4h6p5ra3@eu1.inbound.bird.com",
      "display_name": "Acme Concierge",
      "owner": {
        "id": "ws_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "inbound_address_id": "ina_01krdgeqcxet5s7t44vh8rt9mg"
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.