Sign in

v8

latestOpenAPI 3.1.02026-08-033623795.0 MB
Reviews

Retrieve review

Retrieves the details of an existing review.

get/reviews/{id}

Path parameters

idstring required
Example:rev_xxxxxxxxxxxxxx

The unique identifier of the review to retrieve.

Response

A successful response

created_atstring date-time required

The datetime the review was created.

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 date-time nullable required

The timestamp of when the reviewer first joined the product. Null if unknown.

paid_for_productboolean nullable required

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

published_atstring date-time nullable required

The timestamp of when the review was published. Null if the review has not been published yet.

starsinteger required

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

status'pending' | 'published' | 'removed' required

The statuses a review can have

titlestring nullable required

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

updated_atstring date-time required

The datetime the review was last updated.

Example response

{
  "attachments": [
    {
      "content_type": "image/jpeg",
      "filename": "document.pdf",
      "url": "https://media.whop.com/abc123/optimized.jpg"
    }
  ],
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "route": "pickaxe",
    "title": "Pickaxe"
  },
  "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",
  "product": {
    "id": "prod_xxxxxxxxxxxxx",
    "title": "Pickaxe Analytics"
  },
  "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"
  }
}