Review

{
	"attachments": [
		{
			"content_type": "image/jpeg",
			"filename": "document.pdf",
			"id": "<string>",
			"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",
	"paid_for_product": true,
	"product": {
		"id": "prod_xxxxxxxxxxxxx",
		"title": "Pickaxe Analytics"
	},
	"published_at": "2023-12-01T05:00:00.401Z",
	"stars": 42,
	"status": "pending",
	"title": "Amazing community and tools",
	"updated_at": "2023-12-01T05:00:00.401Z",
	"user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	}
}

array<object>

required

A list of files and media attached to the review.

Show child attributes

string | null

required

Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg.Example: image/jpeg

string | null

required

The original filename of the uploaded attachment, including its file extension.Example: document.pdf

string

required

string | null

required

A pre-optimized URL for rendering this attachment on the client. This should be used for displaying attachments in apps.Example: https://media.whop.com/abc123/optimized.jpg

object

required

The company that this review was written for.

Show child attributes

string

required

The unique identifier for the company.Example: biz_xxxxxxxxxxxxxx

string

required

URL slug for the account’s store page, e.g. pickaxe in whop.com/pickaxe.Example: pickaxe

string

required

The display name of the company shown to customers.Example: Pickaxe

string<date-time>

required

The datetime the review was created.Example: 2023-12-01T05:00:00.401Z

string | null

required

The body text of the review containing the user’s detailed feedback. Returns an empty string if no description was provided.Example: Great product, really helped me grow my audience.

string

required

The unique identifier for the review.Example: rev_xxxxxxxxxxxxxx

string<date-time> | null

required

The timestamp of when the reviewer first joined the product. Null if unknown.Example: 2023-12-01T05:00:00.401Z

boolean | null

required

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

object

required

The product that this review was written for.

Show child attributes

string

required

The unique identifier for the product.Example: prod_xxxxxxxxxxxxx

string

required

The display name of the product shown to customers on the product page and in search results.Example: Pickaxe Analytics

string<date-time> | null

required

The timestamp of when the review was published. Null if the review has not been published yet.Example: 2023-12-01T05:00:00.401Z

integer

required

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

ReviewStatus

required

The current moderation status of the review.Available options: pending, published, removed

string | null

required

A short summary title for the review. Null if the reviewer did not provide one.Example: Amazing community and tools

string<date-time>

required

The datetime the review was last updated.Example: 2023-12-01T05:00:00.401Z

object

required

The user account of the person who wrote this review.

Show child attributes

string

required

The unique identifier for the user.Example: user_xxxxxxxxxxxxx

string | null

required

The user’s display name shown on their public profile.Example: John Doe

string

required

The user’s unique username shown on their public profile.Example: johndoe42

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats