List All Mailboxes

Return a paginated list of every mailbox (campaign) on the authenticated account. Use the query params to filter by status (active, paused, connection-problem), narrow by tags, sort by creation time or daily volume, and opt in to extended fields like SMTP/IMAP connection details or owner info.

Query Params
boolean
Defaults to false

Requests SMTP & IMAP details about the campaign.

string
enum

Specifies the column to sort the results by.

Allowed:
string
enum
Defaults to asc

Indicates the direction of the sort.

Allowed:
integer
1 to 100
Defaults to 10

Limits the number of items per page.

number
Defaults to 1

Specifies the page number of results to retrieve.

string
enum

Filters the results by the specified status.

Allowed:
boolean
Defaults to false

Requests additional details about the owner.

string

Comma-separated string such as "Tag 1, Tag 2, Tag 3"

Headers
string
required

Any unique string, timestamp, or UUID for logging.

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json