POST

Query Recipients


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

FieldSupported FiltersSort
id$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
createdDate$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSort: ASC, DESC
updatedDate$eq, $ne, $exists, $in, $any, $lt, $lte, $gt, $gteSort: ASC, DESC
channelsSort: ASC, DESC
businessLocationIds$eq, $ne, $exists, $in, $any, $allSort: ASC, DESC
tags.publicTags.tagIds$eq, $ne, $exists, $in, $any, $allSort: ASC, DESC
tags.privateTags.tagIds$eq, $ne, $exists, $in, $any, $allSort: ASC, DESC
phone$eq, $ne, $exists, $in, $any, $begins, $gt, $lt, $lte, $gteSort: ASC, DESC
Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/rest-notification-recipients/v1/recipients/query

Errors

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

Did this help?