POST

Query Recipients

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of recipients with optional filtering, sorting, and paging.

Up to 100 recipients can be returned per request.

To learn how to query notification recipients, see API Query Language.

Supported properties for filtering and sorting: id, createdDate, updatedDate, channels

PropertyFiltersSort
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
_createdDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
_updatedDate$eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gteSort: ASC, DESC
channelsSort: ASC, DESC
businessLocationIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
tags.publicTags.tagIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
tags.privateTags.tagIds$eq, $ne, $exists, $in, $hasSome, $hasAllSort: ASC, DESC
phone$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Errors

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

Did this help?