Skip to navigation

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

pageintegerOptional>=1Defaults to 1
Page number
perPageintegerOptional1-200Defaults to 200
Number of records per page, up to 200
productIdstringOptionalformat: "uuid"
Restrict results to reviews for this product
componentIdstringOptionalformat: "uuid"
Restrict results to reviews for this component, including component sample requests
sampleRequestTypeenumOptional

Return only sample requests of this type. component returns component sample requests, and product returns product sample requests.

Allowed values:
filterslist of objectsOptional
Filters

Response

Successful operation
namestring
componentIdstring or nullOptionalformat: "uuid"
Component this review belongs to. Present for component sample requests.
componentStatusenum or nullOptional
Component sample request approval status.
Allowed values:
createdAtdatetimeOptional
developmentStageobjectOptional
developmentStageIdstringOptionalformat: "uuid"
generalCommentstringOptional
hasPendingRevisionsbooleanOptional
idstringOptionalformat: "uuid"
milestoneIdstringOptionalformat: "uuid"
orderIdstringOptionalformat: "uuid"
positionintegerOptional
productIdstringOptionalformat: "uuid"
reviewPhotoslist of objectsOptional
sampleRequestbooleanOptional
Whether this review is a sample request.
sampleReviewMeasureslist of objectsOptional
sizeslist of stringsOptional
statusenumOptional

Review status, can be any of { approved: 0, approved_with_comments: 1, rejected: 2 }

Allowed values:
userobjectOptional
userIdstringOptionalformat: "uuid"

Errors

405
Method Not Allowed Error