ToolsSequences

Search person in sequences

List people in sequence enrollments - who is in which sequence and with what status.

Tool: search_person_in_sequences

Search by name, OR pass filters with no name to list a whole set: sequence_id alone returns that sequence's full enrollment roster (each person + their status); status, qualification_status, do_not_contact, and lead_group_id work the same way. Returns per-person rows. For aggregate funnel counts only (totals, reply/completion %, per-step) without names, use get_sequence(sequence_id=…, include_stats=true) instead. Optionally mark the single name match do-not-contact, which also stops their active enrollments.

Parameters

ParamTypeRequiredDescription
namestringnoFull or partial person name - case-insensitive match on full_name. Alias: person_name. Optional: omit it (with a filter) to list a whole set, e.g. sequence_id alone returns that sequence's roster.
statusstringnoEnrollment status filter: enrolled | active | waiting_duration | waiting_acceptance | stopped | replied | completed | failed_terminal.
limitintegernoMax people returned. Default: 25.
qualification_statusstringnoFilter people: new | qualified | disqualified | customer.
do_not_contactbooleannoFilter people by the do-not-contact flag.
sequence_idstring (slug or UUID)noOnly enrollments in this sequence.
lead_group_idstring (slug or UUID)noOnly members of this lead group.
mark_do_not_contactbooleannotrue → flag the matched person do-not-contact, stop their active enrollments, and cancel planned sends. Applied only when a name is given and exactly one person matches - a filter/roster result or an ambiguous match returns the list with a SKIPPED signal instead.

name is optional when any filter is set - e.g. qualification_status='disqualified' alone lists all disqualified people.

Searches across all sequences unless sequence_id narrows it - every match returns its full enrollment list (sequence, status, angle, next send).

People matching the name but not enrolled anywhere still appear (with empty enrollments) unless a status filter is set.

Sample request — success

{
  "name": "priya"
}

Sample request — mark do not contact

{
  "name": "alex founder",
  "mark_do_not_contact": true
}

Sample request — filter do not contact

{
  "do_not_contact": true
}

On this page