Mailbox API

List mailbox sender identities

Changed on

Returns sender identities available to the authenticated mailbox.

get/mailbox/identities

Request

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

Pagination cursor — the next_cursor from the previous response.

limitinteger

Maximum results (default 50, max 100).

mailbox_idstring

Mailbox public ID to target when the credential grants access to more than one mailbox. Omit when the credential is scoped to exactly one mailbox.

Response

Identity list

oktrue required

Example response

{
  "data": [
    {
      "bcc": [
        {
          "email": "agent@example.com",
          "name": "Support"
        }
      ],
      "reply_to": [
        {
          "email": "agent@example.com",
          "name": "Support"
        }
      ]
    }
  ]
}

Changes