Skip to main content
GET
/
reviews
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const review = await client.reviews.retrieve('rev_xxxxxxxxxxxxxx');

console.log(review.id);
{
  "id": "rev_xxxxxxxxxxxxxx",
  "title": "Amazing community and tools",
  "description": "Great product, really helped me grow my audience.",
  "stars": 42,
  "status": "pending",
  "paid_for_product": true,
  "created_at": "2023-12-01T05:00:00.401Z",
  "updated_at": "2023-12-01T05:00:00.401Z",
  "published_at": "2023-12-01T05:00:00.401Z",
  "joined_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "attachments": [
    {
      "id": "<string>",
      "filename": "document.pdf",
      "content_type": "image/jpeg",
      "url": "https://media.whop.com/abc123/optimized.jpg"
    }
  ],
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Pickaxe",
    "route": "pickaxe"
  },
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "title": "Pickaxe Analytics"
  }
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

The unique identifier of the review to retrieve.

Example:

"rev_xxxxxxxxxxxxxx"

Response

A successful response

A user-submitted review of a company, including a star rating and optional text feedback.

​
id
string
required

The unique identifier for the review.

Example:

"rev_xxxxxxxxxxxxxx"

​
title
string | null
required

A short summary title for the review. Null if the reviewer did not provide one.

Example:

"Amazing community and tools"

​
description
string | null
required

The body text of the review containing the user's detailed feedback. Returns an empty string if no description was provided.

Example:

"Great product, really helped me grow my audience."

​
stars
integer
required

The star rating given by the reviewer, from 1 to 5.

Example:

42

​
status
enum<string>
required

The current moderation status of the review.

Available options:
pending,
published,
removed
​
paid_for_product
boolean | null
required

Whether the reviewer paid for the product. Null if the payment status is unknown.

​
created_at
string<date-time>
required

The datetime the review was created.

Example:

"2023-12-01T05:00:00.401Z"

​
updated_at
string<date-time>
required

The datetime the review was last updated.

Example:

"2023-12-01T05:00:00.401Z"

​
published_at
string<date-time> | null
required

The timestamp of when the review was published. Null if the review has not been published yet.

Example:

"2023-12-01T05:00:00.401Z"

​
joined_at
string<date-time> | null
required

The timestamp of when the reviewer first joined the product. Null if unknown.

Example:

"2023-12-01T05:00:00.401Z"

​
user
object
required

The user account of the person who wrote this review.

​
attachments
object[]
required

A list of files and media attached to the review.

​
company
object
required

The company that this review was written for.

​
product
object
required

The product that this review was written for.