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
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
_id | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
_createdDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
_updatedDate | eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending() |
phone | eq(),ne(),exists(),in(),hasSome(),startsWith(),gt(),lt(),le(),ge(),ascending(),descending() |
businessLocationIds | eq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending() |
channels | ascending(),descending() |
tags.privateTags.tagIds | eq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending() |
tags.publicTags.tagIds | eq(),ne(),exists(),in(),hasSome(),hasAll(),ascending(),descending() |
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:
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.