Sign in
Mailbox API

Get mailbox API session

Changed on

Returns mailbox API capabilities, resource state tokens, limits, and disabled feature flags for the authenticated mailbox.

get/mailbox/session

Request

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

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.

Headers

If-None-Matchstring

Weak ETag from a previous response. Returns 304 when unchanged.

Response

Mailbox API session

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "mailbox": {
      "email": "agent@example.com",
      "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  }
}

Changes