Sign in
Mailbox API

List granted mailboxes

Changed on

Lists the mailboxes available to the current mailbox credential or connected app. Use this before choosing a mailbox_id for mailbox actions when more than one mailbox is available.

get/mailbox/mailboxes

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/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.read)

Query parameters

cursorstring

Cursor from the previous response.

limitinteger

Maximum results (default 50).

qstring

Search by mailbox ID or email address.

Response

Granted mailboxes

oktrue required

Example response

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

Changes