> For the complete documentation index, see [llms.txt](https://docs.cloutly.com/reviews-sdk-for-marketplace-websites/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cloutly.com/reviews-sdk-for-marketplace-websites/rest-api/list-reviews.md).

# Reviews

## GET /reviews

Pull reviews for connected sources in Cloutly.

### Request

```
GET https://app.cloutly.com/api/v1/reviews
```

### Query params

* `source` - `google` | `facebook` (omit for all)
* `showOnWidget` - `true` | `false`
* `limit` - page size
* `offset` - pagination offset
* `businessId` - filter by business
* `sort` - `desc` | `asc`

### Response

```json
{
  "total": 30,
  "reviews": [
    {
      "authorName": "Tim Crowel",
      "businessId": "634d8ed1-11fd-413d-a9a6-d6b8ba0c95a5",
      "createdAt": "2021-02-03T00:00:00.000Z",
      "email": "[email protected]",
      "id": "cbd42728-9c56-4485-813c-4c85d1e64cf4",
      "isArchived": false,
      "name": "Tim Crowel",
      "phoneNumber": null,
      "photo": "https_link_to_CDN",
      "rating": "5",
      "showOnWidget": true,
      "response": {
        "name": "My Business",
        "date": "2021-02-04",
        "comment": "Thank you for the wonderful feedback Tim. We're glad the process was simple and easy and will be sure to pass your feedback on to the team! :) Thanks Tara"
      },
      "shield": false,
      "source": "trustpilot",
      "sourceFeedbackId": "601a81b4679d9705c86295eb",
      "status": "Responded",
      "reviewUrl": "https://example.com/url/to/review/source", // or null
      "text": "Fantastic. Couldn't be more satisfied. The whole process was Simple, Easy, Efficient and the demonstrated true professionalism by thinking on their feet and finding a way to make it happen. Highly recommended.",
      "type": null,
      "videoRef": "/uploads/xxx/xxx.mp4",
      "gifRef": "/uploads/xxx/xxx.gif",
      "updatedAt": "2021-03-01T00:02:21.739Z",
      "canReply": true,
      ...
    }
  ]
}
```

## Notes

* Reviews are ordered by `createdAt: desc` by default.
* Many fields are nullable; null-check before assuming presence.
* `canReply` indicates whether the review can be replied to via API.
