Skip to main content
POST
Filter contacts in sequence

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer
required

Sequence ID

Query Parameters

top
integer

Maximum number of items to return (default 100, max 1000)

skip
integer

Number of items to skip

Body

application/json

Conditions, search and sort for filtering one sequence's contacts.

conditions
Filter condition · object[] | null

Field conditions, joined with AND; one condition per field. Counts, dates and statuses are those of this sequence. GET /v3/sequences/{id}/contacts/filter/fields lists the fields, their operators, value types and allowed values. Up to 200 branches per condition, 200 values per list and 500 values across all conditions. Omit it, or send null or an empty list, to get every contact of the sequence.

Maximum array length: 20
searchTerm
string | null

Free-text search term

sortBy
enum<string> | null

Field to sort by, case-insensitive. Defaults to addingDate, the date the contact was added to the sequence. currentStep orders by step position with finished contacts last; emailAccountName orders by the address of the mailbox that sends to the contact in this sequence.

Available options:
addingDate,
email,
firstName,
lastName,
company,
statusInSequence,
currentStep,
emailAccountName
sortDirection
enum<string> | null

Sort direction, case-insensitive. Defaults to desc.

Available options:
asc,
desc

Response

Filtered contacts of the sequence

Response model for listing contacts in a sequence with pagination

items
Sequence Contact · object[]

Array of sequence contact items

hasMore
boolean
read-only

Indicates if there are more items to fetch