Skip to main content
GET
/
mailboxes
List mailboxes
curl --request GET \
  --url https://app.sendmux.ai/api/v1/mailboxes \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": [
    {
      "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "email": "agent@acme.com",
      "display_name": "<string>",
      "quota_bytes": 123,
      "send_scope": {
        "provider_public_ids": [
          "<string>"
        ],
        "group_public_ids": [
          "<string>"
        ]
      },
      "status": "active",
      "created_at": "<string>"
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Sendmux API key. Use a root API key for Management API routes, or a mailbox credential for Mailbox API routes. Obtain keys from the dashboard under API Keys.

Query Parameters

cursor
string

Pagination cursor — the next_cursor from the previous response.

limit
integer

Max results (default 50, max 100)

Required range: 1 <= x <= 100
include_deleted
enum<string>

Set to true to include soft-deleted mailboxes (status deleted) in the response. Default false. Soft-deleted mailboxes are retained for tenant-isolation references in delivery logs and API keys.

Available options:
true

Response

Mailbox list

ok
enum<boolean>
required
Available options:
true
meta
object
required
data
object[]
required
pagination
object
required