Skip to main content
GET
List mailbox folders

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

Maximum results (default 50, max 100).

Required range: 1 <= x <= 100
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

200 - application/json

Folder list

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