curl --request GET \
--url https://app.sendmux.ai/api/v1/mailbox/me \
--header 'Authorization: Bearer <token>'{
"ok": true,
"data": {
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "agent@acme.com",
"display_name": "<string>",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"provider_public_ids": [
"<string>"
],
"group_public_ids": [
"<string>"
]
},
"status": "active",
"created_at": "<string>",
"quota_used_bytes": 123
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Returns the mailbox the bearer token is scoped to, including live storage usage. Intended for SDK auto-discovery — call once on startup to resolve the mailbox ID. Requires a mailbox-scoped API key; root keys receive 403.
Responses carry a weak ETag header — send it back as If-None-Match on the next request and the server will return 304 Not Modified (no body) when the mailbox state has not changed.
curl --request GET \
--url https://app.sendmux.ai/api/v1/mailbox/me \
--header 'Authorization: Bearer <token>'{
"ok": true,
"data": {
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"email": "agent@acme.com",
"display_name": "<string>",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"provider_public_ids": [
"<string>"
],
"group_public_ids": [
"<string>"
]
},
"status": "active",
"created_at": "<string>",
"quota_used_bytes": 123
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.sendmux.ai/llms.txt
Use this file to discover all available pages before exploring further.
Sendmux API key. Obtain from the dashboard under API Keys. Format: smx_root_...
Weak ETag from a previous response. Returns 304 when unchanged.
The calling mailbox
true Hide child attributes
Public ID
"mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
Mailbox email address (lowercase)
"agent@acme.com"
Optional display name shown in outbound From headers
Storage quota in bytes
Hide child attributes
Outbound routing strategy. all lets the mailbox use any team-configured provider; providers restricts to the listed provider IDs; group routes via a delivery group.
all, providers, group Provider public IDs (only when type=providers)
Delivery group public IDs (only when type=group)
active | suspended | deleted
"active"
ISO 8601 creation timestamp
Live storage usage in bytes. Omitted if the upstream read failed.
Was this page helpful?