Introduction

🏠 Home
🔑 Authentication
🔒 OAuth Implementation
⛔️ Error Handling

oauth

Obtain a user's access tokenpost
Retrieve Userget
Retrieve User Membershipsget

Whop API

Products
Plans
Memberships
Companies
- Retrieve a Companyget
Experiences
Payments
- List Paymentsget
- Retrieve a Paymentget
Checkout Sessions
Members
- Retrieve Memberget
Customers
- List Customersget
- Retrieve Customerget
Promo Codes
Webhooks
Reviews
- List Reviewsget
- Retrieve a reviewget

Example Webhooks

membership.went_valid
membership.went_invalid
payment.succeeded
payment.failed
membership.metadata_updated

Other

⇪ Upgrading from v1.0
📖 View our integration docs
Whop Dev Discord Server

Introduction

🏠 Home
🔑 Authentication
🔒 OAuth Implementation
⛔️ Error Handling

oauth

Obtain a user's access tokenpost
Retrieve Userget
Retrieve User Membershipsget

Whop API

Products
Plans
Memberships
Companies
- Retrieve a Companyget
Experiences
Payments
- List Paymentsget
- Retrieve a Paymentget
Checkout Sessions
Members
- Retrieve Memberget
Customers
- List Customersget
- Retrieve Customerget
Promo Codes
Webhooks
Reviews
- List Reviewsget
- Retrieve a reviewget

Example Webhooks

membership.went_valid
membership.went_invalid
payment.succeeded
payment.failed
membership.metadata_updated

Other

⇪ Upgrading from v1.0
📖 View our integration docs
Whop Dev Discord Server

List Reviews

get https://api.whop.com/api/v2/reviews

Returns a list of all your reviews. Can be searched by User or by Product

URL Expired

The URL for this request expired after 30 days.

Query Params

page

int32

Defaults to 1

The page number to retrieve

per

int32

Defaults to 10

The number of resources to return per page. There is a limit of 50 results per page.

user_id

string

The ID of the User that made the Review(s), which will look like user_*************

product_id

string

The ID of the Product to find Reviews on, which will look like prod_************* or pass_*************

access_pass_id

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

expand

array of strings

Whether or not to expand the User or Product on the returned Review(s). Pass an array with each object(s) you want to expand, e.g. [product, user]

expand

Headers

Authorization

string

Your API key, which can be found on the Whop Business Dashboard. You must prepend your key with the word 'Bearer', which will look like Bearer ***************************

Response

Response body

object

pagination

object

Pagination model

current_page

int32

The current page of the paginated response

total_page

int32

The total number of pages in the paginated response

total_count

int32

The total number of objects in the paginated response (automatically maxed out at 50)

data

array of objects

data

object

string

The ID of the Review, which will look like rev_*************

user

string

The User that made this Review. By default this will just be the ID of the User, but you can expand it to get more information about the User by passing [user] in the expand parameter.

product

string

The Product attached to this Review. By default this will just be the ID of the Product, but you can expand it to get more information about the Product by passing [product] in the expand parameter.

stars

int32

The number of starts the user gave your Product

title

string

The title of this Review

description

string

The body or written description of this review

created_at

string

The time at which the Review was created. Measured in seconds since the Unix epoch.

access_pass

string

Access Pass has been deprecated for Product. Please use product instead and do not use access_pass.

Updated over 1 year ago

Delete a Webhook

Retrieve a review

Did this page help you?

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.whop.com/api/v2/reviews?page=1&per=10' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated over 1 year ago

Delete a Webhook

Retrieve a review

Did this page help you?

Introduction
🏠 Home
🔑 Authentication
🔒 OAuth Implementation
⛔️ Error Handling

oauth
Obtain a user's access tokenpost
Retrieve Userget
Retrieve User Membershipsget

Whop API
Products
Update a Productpost
Retrieve a Productget
List Productsget
Plans
Create a quick linkpost
Update a Planpost
Retrieve a Planget
Create a planpost
List Plansget
Memberships
Validate a License Keypost
Cancel a Membershippost
Terminate a Membershippost
Add Free Days to a Membershippost
Update a Membershippost
Retrieve a Membershipget
List Membershipsget
Companies
Retrieve a Companyget
Experiences
Delete an Experiencedelete
Update an Experiencepost
Retrieve an Experienceget
List Experiencesget
Payments
Retrieve a Paymentget
List Paymentsget
Checkout Sessions
Delete a Checkout Sessiondelete
Retrieve a Checkout Sessionget
Create a Checkout Sessionpost
List Checkout Sessionsget
Members
Retrieve Memberget
Customers
Retrieve Customerget
List Customersget
Promo Codes
Delete a promo codedelete
Update a promo codepost
Retrieve a promo codeget
Create a promo codepost
List Promo Codesget
Webhooks
Delete a Webhookdelete
Update a Webhookpost
Retrieve a Webhookget
Create a Webhookpost
List Webhooksget
Reviews
Retrieve a reviewget
List Reviewsget

Example Webhooks
membership.went_valid
membership.went_invalid
payment.succeeded
payment.failed
membership.metadata_updated

Other
⇪ Upgrading from v1.0

Introduction
🏠 Home
🔑 Authentication
🔒 OAuth Implementation
⛔️ Error Handling

oauth
Obtain a user's access tokenpost
Retrieve Userget
Retrieve User Membershipsget

Whop API
Products
Update a Productpost
Retrieve a Productget
List Productsget
Plans
Create a quick linkpost
Update a Planpost
Retrieve a Planget
Create a planpost
List Plansget
Memberships
Validate a License Keypost
Cancel a Membershippost
Terminate a Membershippost
Add Free Days to a Membershippost
Update a Membershippost
Retrieve a Membershipget
List Membershipsget
Companies
Retrieve a Companyget
Experiences
Delete an Experiencedelete
Update an Experiencepost
Retrieve an Experienceget
List Experiencesget
Payments
Retrieve a Paymentget
List Paymentsget
Checkout Sessions
Delete a Checkout Sessiondelete
Retrieve a Checkout Sessionget
Create a Checkout Sessionpost
List Checkout Sessionsget
Members
Retrieve Memberget
Customers
Retrieve Customerget
List Customersget
Promo Codes
Delete a promo codedelete
Update a promo codepost
Retrieve a promo codeget
Create a promo codepost
List Promo Codesget
Webhooks
Delete a Webhookdelete
Update a Webhookpost
Retrieve a Webhookget
Create a Webhookpost
List Webhooksget
Reviews
Retrieve a reviewget
List Reviewsget

Example Webhooks
membership.went_valid
membership.went_invalid
payment.succeeded
payment.failed
membership.metadata_updated

Other
⇪ Upgrading from v1.0

200List Reviews