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 | Filters | Sort |
|---|---|---|
id | $eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gte | Sort: ASC, DESC |
createdDate | $eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
updatedDate | $eq, $ne, $exists, $in, $hasSome, $lt, $lte, $gt, $gte | Sort: ASC, DESC |
channels | Sort: ASC, DESC | |
businessLocationIds | $eq, $ne, $exists, $in, $hasSome, $hasAll | Sort: ASC, DESC |
tags.publicTags.tagIds | $eq, $ne, $exists, $in, $hasSome, $hasAll | Sort: ASC, DESC |
tags.privateTags.tagIds | $eq, $ne, $exists, $in, $hasSome, $hasAll | Sort: ASC, DESC |
phone | $eq, $ne, $exists, $in, $hasSome, $startsWith, $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.