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. If you receive as many records as you requested via limit
, make a subsequent request with an increased offset
to retrieve more records.
Recipient structure
Parameter | Type | Description |
---|---|---|
_id | String | Unique ID |
userId | String | User ID that created this recipient |
createdAt | Date | When it was created |
updatedAt | Date | When it was last updated |
sequenceId | String | ID of the sequence this recipient is associated with |
String | The email address of the recipient | |
state | String | One of the following: |
variables | Object | Arbitrary key/value pairs for this recipient. If the content |