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
  • 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
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>
Errors

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

Did this help?