getReview( )
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 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
.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Bookings Services and Settings
Read reviews
Manage Reviews
Manage Restaurants - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
reviewIdstringRequired
Review ID.
optionsGetReviewOptions
Information about the reviews to retrieve.
Returns
Return Type:Promise<Review>
Was this helpful?
Yes
No