Sign in
Mailboxes

List mailboxes

Changed on

Returns a cursor-paginated list of mailboxes configured for the team, ordered by created_at descending. Pass cursor=<next_cursor> from the previous response to fetch the next page.

get/mailboxes

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailboxes
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.admin.read)

Query parameters

cursorstring

Pagination cursor — the next_cursor from the previous response.

limitinteger

Max results (default 50, max 100)

include_deleted'true'

Set to true to include deleted mailboxes in the response. Default false. Deleted mailboxes are retained for audit and delivery history.

Response

Mailbox list

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": [
    {
      "email": "agent@acme.com",
      "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "status": "active"
    }
  ]
}

Changes