Skip to main content
GET
/
mailbox
/
me
Self-introspect the calling mailbox
curl --request GET \
  --url https://app.sendmux.ai/api/v1/mailbox/me \
  --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>",
    "quota_used_bytes": 123
  }
}

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.

Headers

​
If-None-Match
string

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

Query Parameters

​
mailbox_id
string

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

The calling mailbox

​
ok
enum<boolean>
required
Available options:
true
​
meta
object
required
​
data
object
required