Skip to main content
GET
List mailboxes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

Opaque cursor from a previous response’s meta.nextCursor.

Example:

"eyJ0cyI6IjIwMjYtMDctMDJUMDA6MDA6MDAuMDAwWiIsImlkIjoiM2YxYzJiN2UtOWE0ZC00ZTE4LWIyYzEtNmQ4ZjVhMGU3YzkzIn0"

limit
number
default:50
Required range: 1 <= x <= 250
Example:

50

status
enum<string>

Filter by lifecycle status.

Available options:
active,
inactive,
checking,
revoked,
failed
email
string

Look a mailbox up by its address (exact, case-insensitive) instead of by id. Returns at most one mailbox, or an empty data array if you have no mailbox with that address.

tags
string

Only mailboxes carrying at least ONE of these tag ids (comma-separated). Read the ids from tags[] on any mailbox; tags themselves are managed in the dashboard.

Example:

"5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f,7a1d2e88-3b5c-4d62-8e9f-2b3c4d5e6f70"

Response

data
object[]
required
meta
object
required