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

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

// 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": "<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>"
        }
      ]
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization
string
header
required

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

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 ID of the product

Example:

"prod_xxxxxxxxxxxxx"

min_stars
integer | null

The minimum star rating of the review (inclusive)

Example:

42

max_stars
integer | null

The maximum star rating of the review (inclusive)

Example:

42

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.