Skip to main content
GET
List mailboxes

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

Pagination cursor — the next_cursor from the previous response.

limit
integer

Max results (default 50, max 100)

Required range: 1 <= x <= 100
include_deleted
enum<string>

Set to true to include deleted mailboxes in the response. Default false. Deleted mailboxes are retained for audit and delivery history.

Available options:
true

Response

Mailbox list

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