curl --request GET \
--url https://app.sendmux.ai/api/v1/mailboxes \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sendmux.ai/api/v1/mailboxes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sendmux.ai/api/v1/mailboxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.sendmux.ai/api/v1/mailboxes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"ok": true,
"data": [
{
"created_at": "<string>",
"display_name": "<string>",
"email": "agent@acme.com",
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"group_public_ids": [
"<string>"
],
"provider_public_ids": [
"<string>"
]
},
"status": "active"
}
],
"pagination": {
"has_more": true,
"next_cursor": "<string>"
}
}{
"error": {
"code": "invalid_parameter",
"message": "<string>",
"retryable": false,
"doc_url": "<string>",
"errors": [
{
"code": "invalid_string",
"field": "recipient.email",
"message": "<string>"
}
],
"param": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"ok": false
}{
"error": {
"code": "invalid_parameter",
"message": "<string>",
"retryable": false,
"doc_url": "<string>",
"errors": [
{
"code": "invalid_string",
"field": "recipient.email",
"message": "<string>"
}
],
"param": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"ok": false
}List mailboxes
Returns a cursor-paginated list of mailboxes configured for the team, ordered by created_at descending. Pass cursor=<next_cursor> from the previous response to fetch the next page.
curl --request GET \
--url https://app.sendmux.ai/api/v1/mailboxes \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sendmux.ai/api/v1/mailboxes"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.sendmux.ai/api/v1/mailboxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.sendmux.ai/api/v1/mailboxes"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"ok": true,
"data": [
{
"created_at": "<string>",
"display_name": "<string>",
"email": "agent@acme.com",
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
"quota_bytes": 123,
"send_scope": {
"type": "all",
"group_public_ids": [
"<string>"
],
"provider_public_ids": [
"<string>"
]
},
"status": "active"
}
],
"pagination": {
"has_more": true,
"next_cursor": "<string>"
}
}{
"error": {
"code": "invalid_parameter",
"message": "<string>",
"retryable": false,
"doc_url": "<string>",
"errors": [
{
"code": "invalid_string",
"field": "recipient.email",
"message": "<string>"
}
],
"param": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"ok": false
}{
"error": {
"code": "invalid_parameter",
"message": "<string>",
"retryable": false,
"doc_url": "<string>",
"errors": [
{
"code": "invalid_string",
"field": "recipient.email",
"message": "<string>"
}
],
"param": "<string>"
},
"meta": {
"request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"ok": false
}Authorizations
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.
Query Parameters
Pagination cursor — the next_cursor from the previous response.
Max results (default 50, max 100)
1 <= x <= 100Set to true to include deleted mailboxes in the response. Default false. Deleted mailboxes are retained for audit and delivery history.
true Response
Mailbox list
true Hide child attributes
Hide child attributes
ISO 8601 creation timestamp
Optional display name shown in outbound From headers
Mailbox email address (lowercase)
"agent@acme.com"
Public ID
"mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
Storage quota in bytes. Current writable tiers are 1 GB, 5 GB, and 50 GB.
Hide child attributes
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 Delivery group public IDs (only when type=group)
Provider public IDs (only when type=providers)
active | suspended | deleted
"active"
Was this page helpful?