Mailbox API

List mailbox submissions

Changed on

Returns a cursor-paginated list of send submissions for the authenticated mailbox, including delivery lifecycle fields when available.

get/mailbox/submissions

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailbox/submissions
  • 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)

Query parameters

cursorstring
limitinteger
identity_idsstring

Comma-separated identity IDs, maximum 100.

email_idsstring

Comma-separated message IDs, maximum 100.

thread_idsstring

Comma-separated thread IDs, maximum 100.

undo_status'pending' | 'final' | 'canceled'
afterstring
beforestring
sort_by'send_at' | 'email_id' | 'thread_id'
sort_direction'asc' | 'desc'
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

Submission list

oktrue required

Changes

    • breaking

      the //// response's property type changed from object null to no type for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • 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 required property ////// to the response with the status

    • info

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

    • info

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