Skip to main content
GET
/
v1
/
reviews
List
curl --request GET \
  --url https://{defaultHost}/v1/reviews \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 0,
    "limit": 20,
    "page": 1,
    "url": "/v1/reviews"
  },
  "data": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
page
integer

The page of items you want returned.

​
product_ids[]
string[]

Only return objects that belong to the given products.

​
query
string

The query to be used for full text search of this collection.

​
stars[]
string[]

Only return reviews with the given star ratings.

​
status[]
string[]

Only return objects with the given status.

​
verified
boolean

Only return reviews that are verified or not verified.

​
sort
string

The sorting column and order to be used for this collection. Available sorting columns for this endpoint are created_at, stars, and updated_at.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.