List sending mailboxes
Returns the team’s sending mailboxes with connection health, warmup state, today’s usage and who each belongs to, plus fleet-wide counts in summary.
A sequence with an email step can be enabled only when a mailbox in its own sending pool is ready (can_send true, is_paused false and is_connected true). The pool is the sequence’s email_account_ids if set, otherwise the mailboxes assigned to its author, otherwise the team’s shared mailboxes.
- Paging. Send
pageorlimit(1 to 200, default 25) to page through the list. With no query parameters at all,dataholds every mailbox in one response, even whenpaginationreports more than one page. - Filters combine and apply before paging.
summaryalways counts the whole fleet, not the filtered set. - Not provisioned.
provisioned: falsewith an emptydatameans the team has no sending account yet; one is created when the first mailbox is connected or the first email sequence is enabled.provisioned: truewith an emptydatameans no mailbox is connected.
Credentials are never returned; the fields are an allowlist. Mailboxes are connected and managed in the dashboard on the Mailboxes page. Reads the sending provider live, so it is slower than other reads, and it requires the team owner, whom reads act as, to have an active plan or seat. Counts against the Sequencer reads rate limit.
email_account_ids if set, otherwise the mailboxes assigned to its author, otherwise the team’s shared mailboxes.
Common queries
Good to know
- A mailbox is ready when
can_sendis true,is_pausedis false andis_connectedis true.can_sendalone only means it is in the pool or assigned to a rep. - Send
pageorlimitto page through the list. With no query parameters,dataholds every mailbox in one response, even whenpaginationreports more than one page. summarycounts the whole fleet whatever the filter, and its counts overlap: a mailbox can be both ready and warming.provisioned: falsemeans the team has no sending account yet. It is created when the first mailbox is connected or the first email sequence is enabled.- Mailboxes are connected and managed in the dashboard on the Mailboxes page. This API does not connect or remove them.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Query Parameters
Case-insensitive match on the sender name, address or domain. At most 200 characters.
200ready: can send now (can_send true, not paused, connected). not_connecting: SMTP or IMAP failed on the last check, so its credentials need fixing. paused: paused on purpose. out_of_pool: neither in the shared pool nor assigned to a rep, so nothing sends from it.
ready, not_connecting, paused, out_of_pool on: warmup is running (warmup_status is ACTIVE). off: it is not.
on, off Mailbox type, matched exactly: GMAIL, OUTLOOK or SMTP. At most 40 characters.
40Only mailboxes carrying this tag (a numeric id from tags).
true: only mailboxes in the shared team pool (can_send and assigned to nobody). false: every other mailbox.
A team member id for that rep's mailboxes, or unassigned for mailboxes no rep owns. At most 64 characters.
64Page number, 1-based, up to 10,000. Sending it turns paging on.
1 <= x <= 10000Results per page. Default 25 once paging is on. Above 200 is treated as 200.
1 <= x <= 200Response
The mailboxes.
Mailboxes in the standard list envelope, plus whether the team has a sending account at all and fleet-wide counts.
Pagination for the paged lists under /v2/sequencer. Every paged list uses this one shape; a few short lists (a sequence's steps, the team's policies, a task's events and enrollment runs) return a plain array instead.
False means the team has no sending account yet, which is a different state from a provisioned team with no mailboxes connected. Both return an empty data.
Counts across the whole fleet rather than the current filter, so they stay usable as the way out of a filter. The status counts overlap: a mailbox can be both ready and warming. Absent on an unprovisioned team.