POST

List Participants


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of participants that belong to one or more audiences, an explicit list of participants, or both.

Retrieve the available audience providers first by calling List Audience Providers. Each audience references a provider's id, together with the input data that provider needs to resolve participants.

Results are paginated per audience: ListParticipants returns participants for a single audience per page before moving on to the next audience in the request. Pass the returned pagingMetadata.cursors.next value in the next call's paging.cursor to get the next page. Treat the cursor as an opaque value.

Include fields: ["ENRICHED"] in the request to also return full contact or Wix user data for each participant.

Authentication

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

Permission Scopes
Set Up Automations
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/audience-service/v1/participants/list

Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?