Fetch all Reviews

curl -G https://api.rechain.co/public/v1/reviews \
     -H "Authorization: Bearer <token>" \
     -d productId=b1f86661-4844-4a98-829a-81b6761f3710 \
     -d componentId=90909090-9090-9090-9090-909090909090

[
  {
    "name": "Review name",
    "componentId": "123e4567-e89b-12d3-a456-426614174000",
    "componentStatus": "approved",
    "createdAt": "2024-09-01T12:34:56Z",
    "developmentStage": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Development Stage Name",
      "color": "gray"
    },
    "developmentStageId": "123e4567-e89b-12d3-a456-426614174000",
    "generalComment": "This is a general comment about the review.",
    "hasPendingRevisions": true,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "milestoneId": "123e4567-e89b-12d3-a456-426614174000",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "position": 1,
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "reviewPhotos": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "fileUrl": "https://example.com/photos/photo.jpg",
        "reviewed": false,
        "position": 1,
        "commentedFileUrl": "https://example.com/photos/commented_photo.jpg",
        "initialFileUrl": "https://example.com/photos/initial_photo.jpg"
      }
    ],
    "sampleRequest": true,
    "sampleReviewMeasures": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "measure": "50 cm",
        "productDimensionId": "123e4567-e89b-12d3-a456-426614174000",
        "productSizeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ],
    "sizes": [
      "123e4567-e89b-12d3-a456-426614174000",
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "status": 1,
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fullName": "John Doe",
      "firstName": "John"
    },
    "userId": "123e4567-e89b-12d3-a456-426614174000"
  }
]

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.

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

Page number

perPageintegerOptional

Number of records per page, up to 200

productIdstringOptional

Restrict results to reviews for this product

componentIdstringOptional

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:

filtersobjectOptional

Filters

Response

This endpoint returns a list of objects.

namestring

componentIdstringOptional

Component this review belongs to. Present for component sample requests.

componentStatusenumOptional

Component sample request approval status.

Allowed values:

createdAtdatetimeOptional

developmentStageobjectOptional

developmentStageIdstringOptional

generalCommentstringOptional

hasPendingRevisionsbooleanOptional

idstringOptional

milestoneIdstringOptional

orderIdstringOptional

positionintegerOptional

productIdstringOptional

reviewPhotoslist of objectsOptional

sampleRequestbooleanOptional

Whether this review is a sample request.

sampleReviewMeasureslist of objectsOptional

sizeslist of stringsOptional

statusintegerOptional

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

userobjectOptional

userIdstringOptional

Errors

405

Method Not Allowed