POST

Query Review Requests


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a list of review requests, give the provided paging, filtering, and sorting.

Query Review Requests runs with these defaults, which you can override:

  • createdDate in ASC order

For field support for filters and sorting, see Review Requests: Supported Filters and Sorting.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

FieldSupported FiltersSort
id$eq, $ne, $in, $ninSort: ✗
namespace$eq, $ne, $in, $ninSort: ✗
communicationChannel$eq, $ne, $in, $ninSort: ✗
recipient.contactId$eq, $ne, $in, $ninSort: ✗
requestedBy.identityType$eq, $ne, $in, $ninSort: ✗
requestedBy.wixUserId$eq, $ne, $in, $ninSort: ✗
requestedBy.appId$eq, $ne, $in, $ninSort: ✗
items.catalogItemId$eq, $ne, $in, $nin, $hasSome, $hasAllSort: ✗
items.reviewId$eq, $ne, $in, $nin, $exists, $hasSome, $hasAllSort: ✗
order.id$eq, $ne, $in, $nin, $existsSort: ✗
automationActivationId$eq, $ne, $in, $nin, $existsSort: ✗
createdDate$eq, $ne, $gt, $gte, $lt, $lte, $in, $ninSort: ASC, DESC
sendDate$eq, $ne, $gt, $gte, $lt, $lte, $in, $ninSort: ASC, DESC
status$eq, $ne, $in, $ninSort: ASC, DESC
Authentication

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

Permissions
Read Review Requests
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/reviews/v2/review-requests/query

Errors

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

Did this help?