listRecipients( )

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.

If no activity is included, this method returns an error.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Access Verticals by Automations
Set Up Automations
Manage Email Marketing
Read Email Marketing
Manage Stores
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
campaignIdstringRequired

Campaign ID.

activityRecipientsActivityEnumRequired

Email activity to filter.

optionsListRecipientsOptions

Options to use when getting the list of recipients.

Returns
Return Type:Promise<ListRecipientsResponse>
Errors

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

Did this help?