Reviews

Retrieve review

Changed on

Retrieves a published review. Reviews that are not published return 404.

get/reviews/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/reviews/{id}
  • Auth: HTTP bearer

Response

Review details

created_atstring required

When the review was created, as an ISO 8601 timestamp.

descriptionstring nullable required

The body text of the review containing the user's detailed feedback. Returns an empty string if no description was provided.

idstring required

The unique identifier for the review.

joined_atstring nullable required

When the reviewer first joined the product, as an ISO 8601 timestamp. Null if unknown.

paid_for_productboolean nullable required

Whether the reviewer paid for the product. Null if the payment status is unknown.

published_atstring nullable required

When the review was published, as an ISO 8601 timestamp. Null if unknown.

starsinteger required

The star rating given by the reviewer, from 1 to 5.

status'published' required

The moderation status of the review. Only published reviews are returned.

titlestring nullable required

A short summary title for the review. Null if the reviewer did not provide one.

updated_atstring required

When the review was last updated, as an ISO 8601 timestamp.

Example response

{
  "account": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "shine-time-auto-detailing",
    "title": "Shine Time Auto Detailing"
  },
  "attachments": [
    {
      "content_type": "image/png",
      "filename": "coated-hood.png",
      "id": "file_xxxxxxxxxxxxxx",
      "url": "https://img.whop.com/xxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx/mb:180000/plain/https://assets-2-rough.whop.com/uploads/image/2026-01-01/review-coated-hood"
    }
  ],
  "created_at": "2026-01-01T12:00:00.000Z",
  "description": "Two years on and the paint still beads like the day it was coated.",
  "id": "rev_xxxxxxxxxxxxxx",
  "joined_at": "2026-01-01T12:00:00.000Z",
  "paid_for_product": true,
  "product": {
    "id": "prod_xxxxxxxxxxxxxx",
    "title": "Ceramic Coating Package"
  },
  "published_at": "2026-01-01T12:00:00.000Z",
  "stars": 4,
  "status": "published",
  "title": "Worth every penny",
  "updated_at": "2026-01-01T12:00:00.000Z",
  "user": {
    "id": "user_xxxxxxxxxxxxxx",
    "name": "Dana Whitfield",
    "username": "danawhitfield"
  }
}

Changes

  • 507636677fe9Revision changes
    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

      the response's property format changed from date-time to no format for status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the path request parameter id

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional header request parameter Api-Version-Date to all path's operations

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the removed enum value from the response property for the response status

    • info

      added the required property to the response with the status