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

const client = new Whop({
  appID: 'app_xxxxxxxxxxxxxx',
  apiKey: 'My API Key',
});

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

console.log(review.id);
{
  "id": "rev_xxxxxxxxxxxxxx",
  "title": "<string>",
  "description": "<string>",
  "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": "<string>",
    "username": "<string>"
  },
  "attachments": [
    {
      "id": "<string>",
      "filename": "<string>",
      "content_type": "<string>",
      "url": "<string>"
    }
  ],
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "<string>",
    "route": "<string>"
  },
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "title": "<string>"
  }
}

Authorizations

Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

id
string
required
Example:

"rev_xxxxxxxxxxxxxx"

Response

A successful response

An object representing a user review of a company.

id
string
required

The internal ID of the review.

Example:

"rev_xxxxxxxxxxxxxx"

title
string | null
required

The title of the review.

description
string | null
required

The description of the review.

stars
integer
required

The number of stars the user gave the product.

Example:

42

status
enum<string>
required

The status of the review.

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

Whether or not the user paid for the product. If null, the payment status is unknown.

created_at
string<date-time>
required

The timestamp of when the review was created.

Example:

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

updated_at
string<date-time>
required

The timestamp of when 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.

Example:

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

joined_at
string<date-time> | null
required

The timestamp of when the user joined the product.

Example:

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

user
object
required

The user account that performed the action.

attachments
object[]
required

The attachments attached to the review.

company
object
required

The company the review is for.

product
object
required

The product the review is for.