Fetch all Reviews
Fetch reviews visible to the public API key. The response is a JSON array.
Results are paginated (default page 1, 200 per page, maximum 200) and ordered
by createdAt descending, then id descending.
Pass productId to list reviews for one product, or componentId for one
component. Pass sampleRequestType=component to list all component sample
requests across the company, or sampleRequestType=product for product
sample requests.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
page
Page number
perPage
Number of records per page, up to 200
productId
Restrict results to reviews for this product
componentId
Restrict results to reviews for this component, including component sample requests
sampleRequestType
Return only sample requests of this type. component returns component sample requests, and product returns product sample requests.
Allowed values:
filters
Filters
Response
Successful operation
name
componentId
Component this review belongs to. Present for component sample requests.
componentStatus
Component sample request approval status.
Allowed values:
createdAt
developmentStage
developmentStageId
generalComment
hasPendingRevisions
id
milestoneId
orderId
position
productId
reviewPhotos
sampleRequest
Whether this review is a sample request.
sampleReviewMeasures
sizes
status
Review status, can be any of { approved: 0, approved_with_comments: 1, rejected: 2 }
Allowed values:
user
userId
Errors
405
Method Not Allowed Error