Skip to main content
GET
Count the contacts a filter matches under each tab

Authorizations

X-API-Key
string
header
required

Path Parameters

sequence_id
string<uuid>
required

Query Parameters

statuses
enum<string>[] | null

Only contacts in these statuses (everything but, with exclude).

Where one contact stands in one sequence.

ACTIVE rows carry a due_at and are what the tick claims; CLAIMED is the in-flight guard between claim and outcome. PAUSED is a deliberate per-contact hold: unclaimable because the tick claims strictly on ACTIVE, yet still LIVE. It keeps its step and its one-live-sequence slot, and a compliance stop (reply, unsubscribe) reaches it. Everything else is settled: COMPLETED walked off the end; STOPPED was halted (reply, unsubscribe, bounce, manual, company pause); FAILED is terminal; SUPPRESSED was on the do-not-contact list; SKIPPED_DUPLICATE lost the one-live-sequence-per-contact rule, with the reason visible in the grid.

A contact the workspace's recontact rule refuses is STOPPED with StopReason.COOLDOWN. There is deliberately no held state: a cooldown settles a contact rather than parking them, so nothing here waits on a date and nothing lets itself out later.

AWAITING_ACTION is a contact parked behind a task that needs a person or a channel, modelled on PAUSED: live, keeps its step and its one-live-sequence slot, unclaimable because the tick claims strictly on ACTIVE, and a compliance stop reaches it. Unlike PAUSED nobody wakes it by hand: only the outreach-task sweep does, once the task it waits on is decided or delivered. Deliberately not "awaiting approval": an AUTO-mode LinkedIn park is waiting for a browser rather than for anyone's approval, and this value is the word the Contacts tab shows for both.

PENDING is a draft's roster: in, standing on a step, and NOT live. Binding an audience enrols on the spot so the Contacts tab can show who is in, but a sequence nobody has launched must not hold anybody's one-live-sequence slot, or a second sequence written for the same people skips them all. uq_sequence_enrolment_one_live leaves PENDING out, the tick never claims it, and launch turns each row ACTIVE, settling the ones another sequence took meanwhile as SKIPPED_DUPLICATE.

Available options:
pending,
active,
claimed,
paused,
awaiting_action,
completed,
stopped,
failed,
suppressed,
skipped_duplicate
stop_reasons
enum<string>[] | null

Only contacts stopped for these reasons (everything but, with exclude).

Available options:
reply,
unsubscribe,
do_not_contact,
bounce,
manual,
company_reply,
row_left_audience,
row_left_paused,
step_removed,
removed,
cooldown,
rejected,
mailbox_removed,
unread_reply,
declined,
trashed,
trashed_paused
exclude
boolean
default:false

Read 'statuses' and 'stop_reasons' as 'everything but', matching the Contacts tab's one Include/Exclude toggle.

search
string | null

Matches the contact's address, company, name or company name.

Maximum string length: 255
created_from
string<date-time> | null

Only contacts added on or after this instant.

created_to
string<date-time> | null

Only contacts added on or before this instant.

outcomes
enum<string>[] | null

Only contacts whose latest settled Browser use run took one of these outcomes, by key (outcome_1 to outcome_8, or needs_human), as each row's browser_outcome says. Never flipped by exclude.

Which way an edge leaves its step.

DEFAULT for message-step flow; YES/NO for a condition's two branches. A connection request leaves by the answer it got: CONNECTED (accepted, and already connected unless that has a branch of its own), ALREADY_CONNECTED (present only when the request splits it out) and NOT_ACCEPTED.

A Browser use step leaves by the outcome its run reached: OUTCOME_1 to OUTCOME_8 are fixed slots whose words the step's browser_config holds (a slot is never given to a second outcome once its first is removed), and NEEDS_HUMAN is the way every run may end, when the site wanted something only a person can give. Fixed slots rather than free keys, so a branch still fits the stored columns, the edge's unique constraint and every reader of this enum.

Available options:
default,
yes,
no,
connected,
already_connected,
not_accepted,
outcome_1,
outcome_2,
outcome_3,
outcome_4,
outcome_5,
outcome_6,
outcome_7,
outcome_8,
needs_human
step_id
string<uuid> | null

Only the contacts of this step of the sequence, as its card in the Builder counts them: with no step_state, everyone whose current step it is.

step_state
enum<string> | null

With step_id: 'waiting' for the contacts still live on the step (due, held, paused, or waiting for an approval), 'failed' for those the step failed for. Each is the list behind the number the step's card shows. Where a contact stands on one step of the Builder, as the step's card counts them.

The card's numbers are not the Audience tab's tabs: a live contact no address reaches is waiting on its card and Blocked on the roster, and a bounce is Blocked but never a failure of the step. A number on a card is always the length of the list it opens.

Available options:
waiting,
failed
step_branch
enum<string> | null

With step_id, instead of step_state: the contacts the step sent down this arm this journey (a check's 'yes' or 'no', a connection request's or a Browser use step's named arm). The list behind the number on the arm in the Builder. Which way an edge leaves its step.

DEFAULT for message-step flow; YES/NO for a condition's two branches. A connection request leaves by the answer it got: CONNECTED (accepted, and already connected unless that has a branch of its own), ALREADY_CONNECTED (present only when the request splits it out) and NOT_ACCEPTED.

A Browser use step leaves by the outcome its run reached: OUTCOME_1 to OUTCOME_8 are fixed slots whose words the step's browser_config holds (a slot is never given to a second outcome once its first is removed), and NEEDS_HUMAN is the way every run may end, when the site wanted something only a person can give. Fixed slots rather than free keys, so a branch still fits the stored columns, the edge's unique constraint and every reader of this enum.

Available options:
default,
yes,
no,
connected,
already_connected,
not_accepted,
outcome_1,
outcome_2,
outcome_3,
outcome_4,
outcome_5,
outcome_6,
outcome_7,
outcome_8,
needs_human
group__not
string[] | null

Leave out the contacts under these tabs, as list_sequence_contacts does. Only 'removed' is taken: with it, 'count' is the All tab's count of the matches and groups.removed reads 0.

Allowed value: "removed"
include_tabs
boolean
default:true

Judge which tab each matching contact sits under. False counts the matches alone, with one count and nobody judged: 'count' is every match, every tab reads 0 and 'capped' is false. For a caller that needs only how many match, such as a confirmation.

Response

Successful Response

How the contacts a roster filter matches split across the Audience tab's tabs.

capped
boolean
required

More contacts match than one read judges, so each tab's count is at least that many.

count
integer
required

Every contact the filters match, the Removed tab's included. The All tab counts this less groups.removed.

groups
ContactGroupCountsReadSchema · object
required

How many of the matching contacts sit under each tab. Each one sits under exactly one, and list_sequence_contacts' 'group' with the same filters lists them.