curl --request GET \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id} \
--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>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Returns a single mailbox, tenant-scoped to the caller’s team. 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 resource has not changed. The same ETag is the value to use in If-Match on PATCH for optimistic concurrency.
curl --request GET \
--url https://app.sendmux.ai/api/v1/mailboxes/{public_id} \
--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>"
},
"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.
Mailbox public ID
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
Was this page helpful?