Skip to main content
GET
Get email accounts

Authorizations

x-api-key
string
header
required

Your API key, from the API keys page of the app.

Query Parameters

warmupStatus
enum<string>

Filter by warmup profile status. Only matches mailboxes that have a warmup profile. Distinct from status, which filters mailbox state.

Available options:
ACTIVE,
PAUSED,
COOLDOWN,
BLOCKED
Example:

"PAUSED"

hasCustomTrackingDomain
boolean

Filter by whether the mailbox uses a custom tracking domain. False also matches mailboxes with no warmup profile, which have none either. Distinct from status, which filters mailbox state.

Example:

false

Response

Email accounts fetched successfully

success
boolean
required
Example:

true

message
string
required
Example:

"Email accounts fetched successfully"

data
object
required