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.

Permissions
Manage Bookings Services and Settings
Manage Reviews
Read reviews
Manage Events
Manage Portfolio
Access Verticals by Automations
Set Up Automations
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?