GET
/
v5
/
company
/
reviews
curl --request GET \
  --url https://{defaultHost}/v5/company/reviews \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "current_page": 123,
    "total_pages": 123,
    "next_page": 123,
    "prev_page": 123,
    "total_count": 123
  },
  "data": [
    {
      "id": "<string>",
      "company_id": "<string>",
      "product_id": "<string>",
      "user_id": "<string>",
      "status": "pending",
      "stars": 123,
      "description": "<string>",
      "joined_at": 123,
      "created_at": 123
    }
  ]
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Query Parameters

​
product_id
string

An ID of a product to filter by, which will look like prod_*************

​
user_id
string

An ID of a user to filter by, which will look like user_*************

​
stars
number

The number of stars to filter by. Ex. 1, 2, 3, 4, or 5.

​
status
enum<string>

A status to filter by.

Available options:
pending,
published,
removed
​
page
integer
default:1

The page number to retrieve

​
per
integer
default:10

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

Response

200 - application/json
reviews retrieved
​
pagination
object
required
​
data
object[]
required

Was this page helpful?

Retrieve a PaymentRetrieve a Review