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

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

// Automatically fetches more pages as needed.
for await (const reviewListResponse of client.reviews.list({ product_id: 'prod_xxxxxxxxxxxxx' })) {
  console.log(reviewListResponse.id);
}
{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

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 ***************************

Query Parameters

​
after
string | null

Returns the elements in the list that come after the specified cursor.

​
before
string | null

Returns the elements in the list that come before the specified cursor.

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

​
product_id
string
required

The unique identifier of the product to list reviews for.

Example:

"prod_xxxxxxxxxxxxx"

​
min_stars
integer | null

The minimum star rating to include in results, from 1 to 5 inclusive.

Example:

42

​
max_stars
integer | null

The maximum star rating to include in results, from 1 to 5 inclusive.

Example:

42

​
created_before
string<date-time> | null

Only return reviews created before this timestamp.

Example:

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

​
created_after
string<date-time> | null

Only return reviews created after this timestamp.

Example:

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

Response

A successful response

The connection type for Review.

​
data
object[]
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.