/sequences/:id/recipients

Retrieves the recipients belonging to the specified sequence. The list of recipients only includes recipients that were activated, it does not include recipients currently in the draft area. Note: This endpoint uses different pagination than most API endpoints. Rather than receiving an object with "results" and "next" keys, you will receive a single array of results as a response. Use the offset query parameter to fetch the next page of results. For example, if you used limit=50 to retrieve the first page, then use offset=50 to retrieve the second page, offset=100 to retrieve the third page, and so on. You're limited to 10,000 total records. So if you're requesting with a offset=9999, you can only request limit=1.

Path Params
string
required

The ID of the Sequence you'd like to add the user to.

Query Params
string
Defaults to ''

The source of the analytics. Defaults to everyone (''), but also accepts 'myself' or a team id.

int32
Defaults to 50

How many records to return. The highest value supported is 50.

int32
Defaults to 0

Which offset to start listing records for. Combined with limit, this can be used to paginate results.

string

The field you would like to sort by. Valid values are "email", "lastStage", "lastMessageCreated", "nextStageScheduledAt", "opens", "clicks", "replied", "downloads", "accepted"

string
Defaults to false

Whether recipients should be sorted in descending order

boolean
Defaults to false

Whether recipient variables should be included in the response

Response

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