Mailbox API

List thread messages

Changed on

Returns cursor-paginated message summaries for one thread. Use the thread content endpoint when you need cleaned bodies.

get/mailbox/threads/{thread_id}/messages

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/threads/{thread_id}/messages
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.read)

Path parameters

thread_idstring required

Thread ID.

Query parameters

cursorstring

Pagination cursor — the next_cursor from the previous response.

limitinteger

Maximum results (default 50, max 100).

sort'asc' | 'desc'

Message sort direction within the thread.

mailbox_idstring

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

Thread messages

oktrue required

Example response

{
  "data": [
    {
      "attachments": [
        {
          "content_type": "application/pdf",
          "disposition": "attachment",
          "download_url": "https://app.sendmux.ai/api/v1/mailbox/messages/msg_123/attachment-downloads/attref_abc123?download_token=...",
          "filename": "invoice.pdf",
          "size_bytes": 12345
        }
      ],
      "bcc": [
        {
          "email": "agent@example.com",
          "name": "Support"
        }
      ],
      "cc": [
        {
          "email": "agent@example.com",
          "name": "Support"
        }
      ],
      "from": {
        "email": "agent@example.com",
        "name": "Support"
      },
      "keywords": [
        "$seen",
        "$flagged",
        "agent_triaged"
      ],
      "to": [
        {
          "email": "agent@example.com",
          "name": "Support"
        }
      ]
    }
  ]
}

Changes

    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      added subschema #2 to the /// response property anyOf list for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status