Skip to main content
GET
List mailboxes (filtered, paged)

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string

Substring on email or sender name.

status
string

active or needs_reconnect.

sending
string

on or off (sending enabled).

tag
string

Exact tag.

domain
string

Exact domain (lowercased).

sort
string

email (default), status, sent_today, daily_limit, last_sent_at, dns_score, created_at.

dir
string

'desc' for descending. Anything else ascending.

size
integer

Page size, 10-1000. Default 100.

page
integer

Page number from 1.

Response

200

JSON {rows:[{id, email, domain, name, kind, status, enabled, daily_limit, sent_today, last_sent_at, last_error, tags, dns_score, warmup_health, created_at, campaigns}], total, page, pages, size, facets:{total, active, needs_reconnect, sending_on, sending_off, sent_today, capacity_today, tags, domains}}.