GET

List Recipients


Retrieves a list of recipients for a selected campaign based on a specific recipient activity.

Pages are returned with a maximum of 1,000 recipients per page and defaults to 40 recipients per page.

Call List Statistics to retrieve a list of activity for selected campaigns. Call List Campaigns to retrieve additional information for your campaigns.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Email Marketing
Read Email Marketing
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/email-marketing/v1/campaigns/{campaignId}/statistics/recipients

Path Params
campaignIdstringRequired

Campaign ID.

Query Params
activitystringRequired

Email activity to filter.


paging.limitintegerminimum 0maximum 1000format int32

Number of items to load.


paging.cursorstring

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.

Response Object
recipientsArray <CampaignRecipientDetails>

List of recipients.


pagingMetadataPagingMetadata

Details on the paged set of returned results.

List Recipients
Request
cURL
curl -X GET 'https://www.wixapis.com/email-marketing/v1/campaigns/8a7f8211-99e4-4116-9d41-da2d11c1e261/statistics/recipients?activity=DELIVERED' \ -H 'Authorization: <AUTH>'
Response
JSON
{ "recipients": [ { "contactId": "7af98416-1939-4239-91fa-8ce9f17cc3f7", "lastActivityDate": "2022-05-13T11:17:45Z" }, { "contactId": "8cef2efc-fe2f-4a30-8136-9d59b901d04c", "lastActivityDate": "2022-05-13T11:17:45Z" } ], "pagingMetadata": { "count": 2 } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?