queryEmailSubscriptions( )


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 email subscriptions, given the provided paging, filtering, and sorting.

Currently, querying is supported on the email field with the $in array filter. For example, to query for emails "me@my.com" and "you@your.org", the filter should be formed like this:

Copy

To learn how to query email subscriptions, see API Query Language.

Authentication

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

Permissions
Manage Email Subscriptions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
filterRecord<string, any>Required

Filter options. Currently, querying is supported on the email field with the $in array filter.


optionsQueryEmailSubscriptionsOptions
Returns
Return Type:Promise<QueryEmailSubscriptionsResponse>
Was this helpful?
Yes
No