Skip to main content
POST
/
mailbox
/
messages:batch-get
Batch get mailbox messages
curl --request POST \
  --url https://app.sendmux.ai/api/v1/mailbox/messages:batch-get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "<string>"
  ]
}
'
{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "messages": [
      {
        "message": {
          "id": "<string>",
          "thread_id": "<string>",
          "folder_ids": [
            "<string>"
          ],
          "subject": "<string>",
          "preview": "<string>",
          "from": {
            "email": "agent@example.com",
            "name": "Support"
          },
          "to": [
            {
              "email": "agent@example.com",
              "name": "Support"
            }
          ],
          "cc": [
            {
              "email": "agent@example.com",
              "name": "Support"
            }
          ],
          "bcc": [
            {
              "email": "agent@example.com",
              "name": "Support"
            }
          ],
          "received_at": "<string>",
          "sent_at": "<string>",
          "size_bytes": 123,
          "has_attachments": true,
          "keywords": [
            "$seen",
            "$flagged",
            "agent_triaged"
          ],
          "flags": {
            "seen": true,
            "flagged": true,
            "draft": true,
            "answered": true
          }
        },
        "raw_body": {
          "id": "<string>",
          "thread_id": "<string>",
          "body": {
            "text": "<string>",
            "html": "<string>",
            "is_truncated": true,
            "truncated_at_chars": 123
          },
          "states": {
            "email_state": "<string>"
          }
        },
        "content": {
          "id": "<string>",
          "thread_id": "<string>",
          "subject": "<string>",
          "participants": {
            "from": {
              "email": "agent@example.com",
              "name": "Support"
            },
            "to": [
              {
                "email": "agent@example.com",
                "name": "Support"
              }
            ],
            "cc": [
              {
                "email": "agent@example.com",
                "name": "Support"
              }
            ],
            "bcc": [
              {
                "email": "agent@example.com",
                "name": "Support"
              }
            ],
            "reply_to": [
              {
                "email": "agent@example.com",
                "name": "Support"
              }
            ]
          },
          "dates": {
            "received_at": "<string>",
            "sent_at": "<string>"
          },
          "body": {
            "text": "<string>",
            "html": "<string>",
            "is_truncated": true,
            "truncated_at_chars": 123,
            "signature_stripped": true,
            "quotes_stripped": true,
            "extracted_links": [
              "<string>"
            ]
          },
          "headers": {
            "selected": {
              "message_id": [
                "<string>"
              ],
              "in_reply_to": "<string>",
              "references": [
                "<string>"
              ],
              "reply_to": [
                {
                  "email": "agent@example.com",
                  "name": "Support"
                }
              ]
            },
            "full": [
              {
                "name": "<string>",
                "value": "<string>"
              }
            ]
          },
          "attachments": [
            {
              "id": "<string>",
              "filename": "<string>",
              "content_type": "application/pdf",
              "size_bytes": 123,
              "disposition": "<string>",
              "content_id": "<string>",
              "download_url": "<string>"
            }
          ],
          "states": {
            "email_state": "<string>",
            "option_hash": "<string>"
          }
        }
      }
    ],
    "not_found": [
      "<string>"
    ],
    "states": {
      "email_state": "<string>"
    }
  }
}

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.

Query Parameters

​
mailbox_id
string

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.

Body

application/json
​
ids
string[]
required
Required array length: 1 - 100 elements
​
body_mode
enum<string>
Available options:
none,
raw,
clean_json
​
part
enum<string>
Available options:
auto,
text,
html,
both
​
max_body_chars
integer
Required range: 1 <= x <= 1000000
​
strip_signature
boolean
​
strip_quotes
boolean
​
include_links
boolean
​
include_html
boolean
​
include_headers
enum<string>
Available options:
none,
selected,
full
​
include_attachments
enum<string>
Available options:
none,
metadata

Response

Batch message result

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