Sign in
Reviews

List reviews

Returns a paginated list of customer reviews for a specific product, with optional filtering by star rating and creation date.

get/reviews

Query parameters

afterstring

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

beforestring

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

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
product_idstring required

The unique identifier of the product to list reviews for.

Example:prod_xxxxxxxxxxxxx
min_starsinteger

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

Example:42
max_starsinteger

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

Example:42
created_beforestring date-time

Only return reviews created before this timestamp.

Example:2023-12-01T05:00:00.401Z
created_afterstring date-time

Only return reviews created after this timestamp.

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

Response

A successful response

Example response

{
  "data": [
    {
      "attachments": [
        {
          "content_type": "image/jpeg",
          "filename": "document.pdf",
          "url": "https://media.whop.com/abc123/optimized.jpg"
        }
      ],
      "created_at": "2023-12-01T05:00:00.401Z",
      "description": "Great product, really helped me grow my audience.",
      "id": "rev_xxxxxxxxxxxxxx",
      "joined_at": "2023-12-01T05:00:00.401Z",
      "published_at": "2023-12-01T05:00:00.401Z",
      "stars": 42,
      "title": "Amazing community and tools",
      "updated_at": "2023-12-01T05:00:00.401Z",
      "user": {
        "id": "user_xxxxxxxxxxxxx",
        "name": "John Doe",
        "username": "johndoe42"
      }
    }
  ]
}

Changes

No changes recorded. 1 of the 74 revisions has no diff computed, so it could not be searched.