v1

latestOpenAPI 3.0.02026-07-24283460.8 KB
Legacy
Reviews and Questions

Retrieve Company Reviews

get/merchant/reviews

Query parameters

storestring required

Your REVIEWS.io public store key

apikeystring

Your REVIEWS.io private api key. This will add additional private data to the API response such as reviewer email addresses.

per_pagenumber

How many items to return per page

pagenumber

Page of results to return

review_idnumber

Unique review id (return a specific review)

order_numberstring

Filter reviews by order number (requires apikey)

branchstring

Filter reviews by branch

service_feedback_email_idstring

Filter reviews by Review Invitation (requires apikey)

min_ratingnumber

Return reviews with rating higher than or equal to min_rating.

max_ratingnumber

Return reviews with rating lower than or equal to max_rating.

min_datestring date

Return reviews newer than min_date.

max_datestring date

Return reviews older than max_date.

min_updatedstring date

Return reviews updated since min_updated.

max_updatedstring date

Return reviews before than max_updated.

order'asc' | 'desc' | 'rating'

Order by

include_repliesboolean

Include replies

whitelistboolean

Return a list of whitelisted URLS for the store

photosboolean

Only return reviews with photos

Response

OK

object required