Skip to main content
GET
/
mailbox
/
session
Get mailbox API session
curl --request GET \
  --url https://app.sendmux.ai/api/v1/mailbox/session \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "mailbox": {
      "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
      "email": "agent@example.com",
      "display_name": "<string>"
    },
    "states": {
      "messages": "<string>",
      "folders": "<string>",
      "threads": "<string>",
      "submissions": "<string>",
      "identities": "<string>",
      "quotas": "<string>"
    },
    "capabilities": {
      "messages": {
        "list": true,
        "detail": true,
        "raw_body": true,
        "clean_content": true,
        "batch_get": true,
        "count": true,
        "search_snippets": true,
        "changes": true,
        "query_changes": true,
        "update_fields": [],
        "keywords": true,
        "batch_update": true,
        "delete": true,
        "permanent_delete": true
      },
      "threads": {
        "list": true,
        "detail": true,
        "messages": true,
        "clean_content": true,
        "changes": true
      },
      "folders": {
        "list": true,
        "detail": true,
        "create": true,
        "update": true,
        "delete": true,
        "changes": true,
        "query_changes": true
      },
      "submissions": {
        "list": true,
        "detail": true,
        "changes": true,
        "send": true
      },
      "identities": {
        "list": true,
        "changes": true,
        "create": true,
        "update": true,
        "delete": true
      },
      "quotas": {
        "list": true,
        "usage": true,
        "changes": true,
        "update": true
      },
      "attachments": {
        "upload": true,
        "download": true,
        "range_download": true,
        "metadata": true,
        "parsing": true,
        "send_with_uploaded_blob": true
      },
      "sync": {
        "typed_changes": true,
        "types": [],
        "query_changes": []
      }
    },
    "limits": {
      "list_limit_max": 123,
      "changes_limit_max": 123,
      "batch_ids_max": 123,
      "message_body_chars_default": 123,
      "thread_body_chars_default": 123,
      "body_chars_max": 123,
      "inline_attachment_bytes_max": 123,
      "attachment_upload_bytes_max": 123,
      "outbound_raw_message_bytes_max": 123,
      "keywords_per_update_max": 123
    },
    "gated": {
      "identity_mutation": true,
      "quota_mutation": true,
      "vacation_response": true,
      "filter_script_writes": true,
      "events": true,
      "raw_protocol": true,
      "attachment_parsing": true,
      "message_copy": true,
      "message_import": true,
      "message_parse": true,
      "blob_lookup": true,
      "blob_copy": true
    },
    "endpoints": {
      "mailbox": [
        "<string>"
      ],
      "messages": [
        "<string>"
      ],
      "threads": [
        "<string>"
      ],
      "folders": [
        "<string>"
      ],
      "submissions": [
        "<string>"
      ],
      "usage": [
        "<string>"
      ],
      "sync": [
        "<string>"
      ]
    }
  }
}

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.

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

Response

Mailbox API session

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