Skip to main content
GET
List sending mailboxes
The team’s sending mailboxes with their health, warmup state and daily capacity. A sequence containing an email step cannot be enabled unless at least one mailbox is connected, unpaused and able to send. Credentials are never returned.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.

Query Parameters

Match on the mailbox address or sender name.

status
enum<string>

ready can send now; not_connecting has failed SMTP or IMAP; out_of_pool is connected but not assigned to anyone or to the shared pool.

Available options:
ready,
not_connecting,
paused,
out_of_pool
warmup
enum<string>

Whether warmup is running on the mailbox.

Available options:
on,
off
esp
string

Email service provider.

tag_id
number

Provider-side tag id.

shared
boolean

Only mailboxes in the shared team pool.

assigned_to
string

Team member the mailbox is assigned to.

page
number

Page number, 1-based.

limit
number

Results per page.

Required range: x <= 200

Response

Success.

Mailboxes in the standard list envelope, plus whether the team has a sending sub-account at all.

data
object[]
required
pagination
object
required

Pagination for every list under /v2/sequencer. One shape across the whole namespace.

provisioned
boolean
required

False means the team has no sending sub-account yet, which is a different state from a provisioned team with no mailboxes connected. Both return an empty data.

summary
object

Counts across the whole fleet rather than the current filter, so they stay usable as the way out of a filter. Absent on an unprovisioned team.