Retrieves a list of recipients with optional filtering, sorting, and paging.
Up to 100 recipients can be returned per request.
For a detailed list of supported operations, see the Supported Filters and Sorting article. To learn how to query notification recipients, see API Query Language.
Supported properties for filtering and sorting:
id, createdDate, updatedDate, channels
| Field | Supported Filters | Sort |
|---|---|---|
id | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
createdDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
updatedDate | $eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
channels | Sort: ASC, DESC | |
businessLocationIds | $eq, $ne, $exists, $in, $any, $all | Sort: ASC, DESC |
tags.publicTags.tagIds | $eq, $ne, $exists, $in, $any, $all | Sort: ASC, DESC |
tags.privateTags.tagIds | $eq, $ne, $exists, $in, $any, $all | Sort: ASC, DESC |
phone | $eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.