Skip to main content
GET
/
mailbox
/
mailboxes
List granted mailboxes
curl --request GET \
  --url https://app.sendmux.ai/api/v1/mailbox/mailboxes \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": [
    {
      "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "email": "agent@acme.com"
    }
  ],
  "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

Cursor from the previous response.

limit
integer

Maximum results (default 50).

Required range: 1 <= x <= 100
q
string

Search by mailbox ID or email address.

Response

Granted mailboxes

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