curl --request GET \
--url https://app.sendmux.ai/api/v1/mailbox/session \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sendmux.ai/api/v1/mailbox/session"
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/mailbox/session', 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/mailbox/session"
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": {
"capabilities": {
"attachments": {
"download": true,
"metadata": true,
"parsing": true,
"range_download": true,
"send_with_uploaded_blob": true,
"upload": true
},
"folders": {
"changes": true,
"create": true,
"delete": true,
"detail": true,
"list": true,
"query_changes": true,
"update": true
},
"identities": {
"changes": true,
"create": true,
"delete": true,
"list": true,
"update": true
},
"messages": {
"batch_get": true,
"batch_update": true,
"changes": true,
"clean_content": true,
"count": true,
"delete": true,
"detail": true,
"keywords": true,
"list": true,
"permanent_delete": true,
"query_changes": true,
"raw_body": true,
"search_snippets": true,
"update_fields": []
},
"quotas": {
"changes": true,
"list": true,
"update": true,
"usage": true
},
"submissions": {
"changes": true,
"detail": true,
"list": true,
"send": true
},
"sync": {
"query_changes": [],
"typed_changes": true,
"types": []
},
"threads": {
"changes": true,
"clean_content": true,
"detail": true,
"list": true,
"messages": true
}
},
"endpoints": {
"folders": [
"<string>"
],
"mailbox": [
"<string>"
],
"messages": [
"<string>"
],
"submissions": [
"<string>"
],
"sync": [
"<string>"
],
"threads": [
"<string>"
],
"usage": [
"<string>"
]
},
"gated": {
"attachment_parsing": true,
"blob_copy": true,
"blob_lookup": true,
"events": true,
"filter_script_writes": true,
"identity_mutation": true,
"message_copy": true,
"message_import": true,
"message_parse": true,
"quota_mutation": true,
"raw_protocol": true,
"vacation_response": true
},
"limits": {
"attachment_upload_bytes_max": 123,
"batch_ids_max": 123,
"body_chars_max": 123,
"changes_limit_max": 123,
"inline_attachment_bytes_max": 123,
"keywords_per_update_max": 123,
"list_limit_max": 123,
"message_body_chars_default": 123,
"outbound_raw_message_bytes_max": 123,
"thread_body_chars_default": 123
},
"mailbox": {
"display_name": "<string>",
"email": "agent@example.com",
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"states": {
"folders": "<string>",
"identities": "<string>",
"messages": "<string>",
"quotas": "<string>",
"submissions": "<string>",
"threads": "<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
}{
"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
}Get mailbox API session
Returns mailbox API capabilities, resource state tokens, limits, and disabled feature flags for the authenticated mailbox.
curl --request GET \
--url https://app.sendmux.ai/api/v1/mailbox/session \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.sendmux.ai/api/v1/mailbox/session"
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/mailbox/session', 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/mailbox/session"
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": {
"capabilities": {
"attachments": {
"download": true,
"metadata": true,
"parsing": true,
"range_download": true,
"send_with_uploaded_blob": true,
"upload": true
},
"folders": {
"changes": true,
"create": true,
"delete": true,
"detail": true,
"list": true,
"query_changes": true,
"update": true
},
"identities": {
"changes": true,
"create": true,
"delete": true,
"list": true,
"update": true
},
"messages": {
"batch_get": true,
"batch_update": true,
"changes": true,
"clean_content": true,
"count": true,
"delete": true,
"detail": true,
"keywords": true,
"list": true,
"permanent_delete": true,
"query_changes": true,
"raw_body": true,
"search_snippets": true,
"update_fields": []
},
"quotas": {
"changes": true,
"list": true,
"update": true,
"usage": true
},
"submissions": {
"changes": true,
"detail": true,
"list": true,
"send": true
},
"sync": {
"query_changes": [],
"typed_changes": true,
"types": []
},
"threads": {
"changes": true,
"clean_content": true,
"detail": true,
"list": true,
"messages": true
}
},
"endpoints": {
"folders": [
"<string>"
],
"mailbox": [
"<string>"
],
"messages": [
"<string>"
],
"submissions": [
"<string>"
],
"sync": [
"<string>"
],
"threads": [
"<string>"
],
"usage": [
"<string>"
]
},
"gated": {
"attachment_parsing": true,
"blob_copy": true,
"blob_lookup": true,
"events": true,
"filter_script_writes": true,
"identity_mutation": true,
"message_copy": true,
"message_import": true,
"message_parse": true,
"quota_mutation": true,
"raw_protocol": true,
"vacation_response": true
},
"limits": {
"attachment_upload_bytes_max": 123,
"batch_ids_max": 123,
"body_chars_max": 123,
"changes_limit_max": 123,
"inline_attachment_bytes_max": 123,
"keywords_per_update_max": 123,
"list_limit_max": 123,
"message_body_chars_default": 123,
"outbound_raw_message_bytes_max": 123,
"thread_body_chars_default": 123
},
"mailbox": {
"display_name": "<string>",
"email": "agent@example.com",
"id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"states": {
"folders": "<string>",
"identities": "<string>",
"messages": "<string>",
"quotas": "<string>",
"submissions": "<string>",
"threads": "<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
}{
"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.
Headers
Weak ETag from a previous response. Returns 304 when unchanged.
Query Parameters
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
Mailbox API session
true Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
seen, flagged, keywords Flags are true when a feature is intentionally unavailable through the mailbox API.
Hide child attributes
Hide child attributes
Hide child attributes
Hide child attributes
Was this page helpful?