GET
/
v2
/
reviews
/
{id}
curl --request GET \
  --url https://api.whop.com/api/v2/reviews/{id}
{
  "id": "<string>",
  "user": "<string>",
  "product": "<string>",
  "stars": 123,
  "title": "<string>",
  "description": "<string>",
  "created_at": "<string>",
  "access_pass": "<string>"
}

Headers

​
Authorization
string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The ID of the Review, which will look like rev_*************

Query Parameters

​
expand
enum<string>[]

Whether or not to expand the User or Product on the returned Review(s). Pass an array with each object(s) you want to expand, e.g. [product, user]

Available options:
product,
user

Response

200 - application/json
Retrieve a review

Review model

​
id
string

The ID of the Review, which will look like rev_*************

​
user
string

The User that made this Review. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing [user] in the expand parameter.

​
product
string

The Product attached to this Review. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.

​
stars
integer

The number of starts the user gave your Product

​
title
string

The title of this Review

​
description
string

The body or written description of this review

​
created_at
string

The time at which the Review was created. Measured in seconds since the Unix epoch.

​
access_pass
string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.