Skip to main content
GET
/
mailbox
/
submissions
List mailbox submissions
curl --request GET \
  --url https://app.sendmux.ai/api/v1/mailbox/submissions \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": [
    {
      "id": "<string>",
      "identity_id": "<string>",
      "email_id": "<string>",
      "thread_id": "<string>",
      "send_at": "<string>",
      "undo_status": "<string>",
      "envelope": {
        "mail_from": {
          "email": "jsmith@example.com",
          "parameters": {}
        },
        "rcpt_to": [
          {
            "email": "jsmith@example.com",
            "parameters": {}
          }
        ]
      },
      "delivery_status": [
        {
          "email": "jsmith@example.com",
          "smtp_reply": "<string>",
          "delivered": "<string>",
          "displayed": "<string>"
        }
      ],
      "dsn_blob_ids": [
        "<string>"
      ],
      "mdn_blob_ids": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "has_more": true,
    "next_cursor": "<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

​
cursor
string
​
limit
integer
Required range: 1 <= x <= 100
​
identity_ids
string

Comma-separated identity IDs, maximum 100.

​
email_ids
string

Comma-separated message IDs, maximum 100.

​
thread_ids
string

Comma-separated thread IDs, maximum 100.

​
undo_status
enum<string>
Available options:
pending,
final,
canceled
​
after
string
​
before
string
​
sort_by
enum<string>
Available options:
send_at,
email_id,
thread_id
​
sort_direction
enum<string>
Available options:
asc,
desc
​
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.

Response

Submission list

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