getReview( )

Retrieves a review.

The getReview() function returns a Promise that resolves to the retrieved review.

By default, an unpublished review is not returned. To retrieve an unpublished review, pass returnPrivateReviews as true.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Bookings Services and Settings
Manage Challenges
Access Verticals by Automations
Set Up Automations
Manage Reviews
Read reviews
Manage Events
Manage Portfolio
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
function getReview(
  reviewId: string,
  options: GetReviewOptions,
): Promise<Review>;
Method Parameters
reviewIdstringRequired

Review ID.

optionsGetReviewOptions

Information about the reviews to retrieve.

Returns
Return Type:Promise<Review>
JavaScript
import { reviews } from "@wix/reviews";

async function getReview(reviewId, options) {
  const response = await reviews.getReview(reviewId, options);
}
Errors

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

Did this help?