List 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": "<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": "John Doe",
        "username": "johndoe42"
      },
      "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
  }
}

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": "<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": "John Doe",
        "username": "johndoe42"
      },
      "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

created_before

string<date-time> | null

The maximum creation date to filter by

Example:

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

created_after

string<date-time> | null

The minimum creation date to filter by

Example:

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

Response

A successful response

The connection type for Review.

data

object[]

required

A list of nodes.

Show child attributes

data.id

string

required

The internal ID of the review.

Example:

"rev_xxxxxxxxxxxxxx"

data.title

string | null

required

The title of the review.

data.description

string | null

required

The description of the review.

data.stars

integer

required

The number of stars the user gave the product.

Example:

42

data.status

enum<string>

required

The status of the review.

Available options:

pending,

published,

removed

data.paid_for_product

boolean | null

required

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

data.created_at

string<date-time>

required

The timestamp of when the review was created.

Example:

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

data.updated_at

string<date-time>

required

The timestamp of when the review was last updated.

Example:

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

data.published_at

string<date-time> | null

required

The timestamp of when the review was published.

Example:

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

data.joined_at

string<date-time> | null

required

The timestamp of when the user joined the product.

Example:

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

data.user

object

required

The user account that performed the action.

Show child attributes

data.user.id

string

required

The internal ID of the user.

Example:

"user_xxxxxxxxxxxxx"

data.user.name

string | null

required

The name of the user from their Whop account.

Example:

"John Doe"

data.user.username

string

required

The username of the user from their Whop account.

Example:

"johndoe42"

data.attachments

object[]

required

The attachments attached to the review.

Show child attributes

data.attachments.id

string

required

The ID of the attachment

data.attachments.filename

string | null

required

The name of the file

data.attachments.content_type

string | null

required

The attachment's content type (e.g., image/jpg, video/mp4)

data.attachments.url

string | null

required

This is the URL you use to render optimized attachments on the client. This should be used for apps.

page_info

object

required

Information to aid in pagination.

Show child attributes

page_info.end_cursor

string | null

required

When paginating forwards, the cursor to continue.

page_info.start_cursor

string | null

required

When paginating backwards, the cursor to continue.

page_info.has_next_page

boolean

required

When paginating forwards, are there more items?

page_info.has_previous_page

boolean

required

When paginating backwards, are there more items?

Retrieve shipment Retrieve review

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

Authorizations

Query Parameters

Response