/sequences/search

Searches the recipients of every sequence you have access to, including sequences shared with you, and returns each match with its status and per-stage activity. A person in several sequences appears once per sequence.

Neither query nor recipients is required. Leaving both out returns every recipient you can see, 50 at a time.

The matches are under recipients. The sequences object is always empty.

Recipient-level times (createdAt, completedAt, lastStageProcessedAt, lastStageSentAt, nextStageScheduledAt) are Unix seconds. Stage times scheduledAt, processedAt and sentAt are Unix milliseconds. Stage ordinal and lastStageSent.ordinal count from 0.

Managed API keys require the sequences:read permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A search string matched against recipients, for example a name or a full email address. Leave out to match everyone.

string

One recipient email address to match exactly. The match is case-sensitive. Passing more than one address currently returns no results, so search one address per request.

string

Only return recipients of this sequence. Returns 404 if the sequence does not exist or you can't access it.

int32
1 to 50
Defaults to 50

How many recipients to return, from 1 to 50.

int32
Defaults to 0

How many matching recipients to skip. Use with limit to page through results.

string
Defaults to state

The recipient field to sort by, such as state, email, createdAt or lastStageSentAt. Ties are broken by lastStageProcessedAt, newest first.

boolean
Defaults to false

true to sort in descending order.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!