/sequences/:id/recipients

get

https://api.mixmax.com/v1/sequences/{id}/recipients/

Lists the recipients of a sequence you have access to, with per-stage activity. Only recipients that were added to the sequence are listed; recipients still in the draft are not.

The response is a plain array, not an object with results and next. Page with limit (at most 50) and offset. offset plus limit can't go past 25,000; asking for more returns 400.

Recipient createdAt is in Unix seconds. Stage times (scheduledAt, processedAt, sentAt) are Unix milliseconds. Stage ordinal counts from 1.

Managed API keys require the sequences:read permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The id of the sequence.

Query Params

limit

int32

≤ 50

Defaults to 50

How many recipients to return. Values above 50 are treated as 50.

offset

int32

Defaults to 0

How many recipients to skip. Use with limit to page through results. offset plus limit can be at most 25,000.

sortBy

string

Defaults to lastMessageCreated

The field to sort by. One of email, lastStage, lastMessageCreated, nextStageScheduledAt, opens, clicks, downloads, replied, accepted, declined or tentative. Any other value sorts by email.

sortDesc

boolean

Defaults to true

false to sort in ascending order.

query

string

A search string that narrows the list, for example a full email address.

analyticsFrom

string

Whose recipients to include: leave out for everyone, myself for recipients you added, or a team id for recipients added by that team.

includeVariables

boolean

Defaults to false

true to include each recipient's variables.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200The recipients.

400The query string is not valid, offset plus limit is above 25,000, or limit is negative.

403A managed API key was used without the sequences:read permission.

404The sequence does not exist or you can't access it.

500The search failed.