Skip to main content
GET
List sending mailboxes
The mailboxes a team sends from, with their health and today’s usage. Check it before enabling a sequence with an email step: at least one mailbox in that sequence’s sending pool must be ready. The pool is the sequence’s 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_send is true, is_paused is false and is_connected is true. can_send alone only means it is in the pool or assigned to a rep.
  • Send page or limit to page through the list. With no query parameters, data holds every mailbox in one response, even when pagination reports more than one page.
  • summary counts the whole fleet whatever the filter, and its counts overlap: a mailbox can be both ready and warming.
  • provisioned: false means 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

x-api-key
string
header
required

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.

Maximum string length: 200
status
enum<string>

ready: 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.

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

on: warmup is running (warmup_status is ACTIVE). off: it is not.

Available options:
on,
off
esp
string

Mailbox type, matched exactly: GMAIL, OUTLOOK or SMTP. At most 40 characters.

Maximum string length: 40
tag_id
number

Only mailboxes carrying this tag (a numeric id from tags).

shared
boolean

true: only mailboxes in the shared team pool (can_send and assigned to nobody). false: every other mailbox.

assigned_to
string

A team member id for that rep's mailboxes, or unassigned for mailboxes no rep owns. At most 64 characters.

Maximum string length: 64
page
number

Page number, 1-based, up to 10,000. Sending it turns paging on.

Required range: 1 <= x <= 10000
limit
number

Results per page. Default 25 once paging is on. Above 200 is treated as 200.

Required range: 1 <= x <= 200

Response

The mailboxes.

Mailboxes in the standard list envelope, plus whether the team has a sending account at all and fleet-wide counts.

data
object[]
required
pagination
object
required

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.

provisioned
boolean
required

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.

summary
object

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.