Get Reviews

List reviews for a supplier

GET /vendor/{vendorId}/reviews

Pull a list of reviews for all your connected sources in Cloutly.

The review list includes:

  • Reviews captured by Cloutly

  • Product reviews captured by Cloutly

  • Google, Facebook, etc. reviews (if connected)

Request

GET https://marketplace.cloutly.com/api/v2/vendors/{vendorId}/reviews

Response

{
  "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",
      ...
    }
  ]
}

Notes:

  • reviews are ordered by createdAt: desc, which means the latest review will always be at the beginning of the list.

  • All fields a nullable so remember to unwrap fields if you are expecting a required value.

  • The ... in the response body indicates that new fields may be added over time.

  • We will consider changing field names or removing fields to be a breaking change and will publish a new version (V2 in this case).

If you have any questions regarding the REST API, feel free to chat us any time.

Last updated