Skip to main content
Use the Reviews API to list a product’s reviews, filtered by star rating or creation date, and retrieve a review by ID.

Endpoints

Attributes

string
required
The unique identifier for the review.
object
required
The account that this review was written for.

Properties

string
required
The unique identifier for the account.
string
required
URL slug for the account’s store page. For example, pickaxe in whop.com/pickaxe.
string
required
The display name of the account shown to customers.
object[]
required
A list of files and media attached to the review.

Properties

string
required
The unique identifier for the attachment.
string | null
required
Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.
string | null
required
The original filename of the uploaded attachment, including its file extension.
string | null
required
A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.
string
required
When the review was created, as an ISO 8601 timestamp.
string | null
required
The body text of the review containing the user’s detailed feedback. Returns an empty string if no description was provided.
string | null
required
When the reviewer first joined the product, as an ISO 8601 timestamp. Null if unknown.
boolean | null
required
Whether the reviewer paid for the product. Null if the payment status is unknown.
object
required
The product that this review was written for.

Properties

string
required
The unique identifier for the product.
string
required
The display name of the product shown to customers on the product page and in search results.
string | null
required
When the review was published, as an ISO 8601 timestamp. Null if unknown.
integer
required
The star rating given by the reviewer, from 1 to 5.
string
required
The moderation status of the review. Only published reviews are returned.Available options: published
string | null
required
A short summary title for the review. Null if the reviewer did not provide one.
string
required
When the review was last updated, as an ISO 8601 timestamp.
object
required
The user account of the person who wrote this review.

Properties

string
required
The unique identifier for the user.
string | null
required
The user’s display name shown on their public profile.
string
required
The user’s unique username shown on their public profile.
Review