Get Campaign Recipients
GET {{baseUrl}}/v1/campaign/:campaign_id/recipients?count=25000&sort=asc&offset=next_offset
Returns summary information about email recipients for the campaign specified that includes each recipients email, customer ID, and status.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
count | number | For pagination, the number of results to return. Max = 25,000 | |
sort | string | Sort order to apply to results, either ascending or descending. Valid values are asc or desc . Defaults to asc . | |
offset | string | For pagination, if a response to this endpoint includes a next_offset , use that value to get the next page of recipients. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":1,"data":[{"email":"abraham.lincoln@klaviyo.com","status":"Sent","customer_id":"PROFILE_ID","variation_id":null}],"next_offset":"NEXT_OFFSET"}