Consumer API

Get a consumer's reviews

This method gets the reviews written by the individual consumer.

GET

Authentication: API Key

https://api.trustpilot.com/v1/consumers/{consumerId}/reviews

Parameters

orderBy, Optional Array
The order in which the results should be sorted.
Default value: [ "createdat.desc" ]
Example: ?orderBy=createdat.asc

perPage, Optional Integer
The number of reviews to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?perPage=3

businessUnitId, Optional String
Filter reviews for a specific business unit.
Example: ?businessUnitId=507f191e810c19729de860ea

language, Optional Array
Filter by reviews with only a specific language.
Example: ?language=en

internalLocationId, Optional String
Filter by reviews with only a specific location.
Example: ?internalLocationId=f994ac75-2f51-456a-9be9-ec30eadae778

consumerId, Required String
The id of the consumer.
Example: …/v1/consumers/507f191e810c19729de860ea/reviews

stars, Optional Array
Filter by reviews with a specific number of stars.
Constraints: The allowed range is minimum: 1, maximum: 5
Example: ?stars=5

includeReportedReviews, Optional Boolean
Include reported reviews.
Default value: false
Example: ?includeReportedReviews=true

page, Optional Integer
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=1

Response

{
  "reviews": [
    {
      "links": [
        {
          "href": "<Url for the resource>",
          "method": "<Http method for the resource>",
          "rel": "<Description of the relation>"
        }
      ],
      "text": "This shop is great.",
      "updatedAt": "2013-09-07T13:37:00",
      "numberOfLikes": 10,
      "id": "507f191e810c19729de860ea",
      "createdAt": "2013-09-07T13:37:00",
      "title": "My review",
      "countsTowardsLocationTrustScore": false,
      "location": {
        "urlFormattedName": "Pilestraede58",
        "id": "43f51215-a1fc-4c60-b6dd-e4afb6d7b831",
        "name": "Pilestraede 58"
      },
      "stars": 5,
      "isVerified": true,
      "status": "active",
      "businessUnit": {
        "identifyingName": "trustpilot.com",
        "displayName": "Trustpilot",
        "id": "507f191e810c19729de860ea",
        "links": [
          {
            "href": "<Url for the resource>",
            "method": "<Http method for the resource>",
            "rel": "<Description of the relation>"
          }
        ]
      },
      "businessUnitHistory": [
        {
          "identifyingName": "example.com",
          "displayName": "Example Inc.",
          "businessUnitId": "507f191e810c19729de860ea",
          "changeDate": "2013-09-07T13:37:00"
        }
      ],
      "reviewVerificationLevel": "invited",
      "companyReply": {
        "text": "This is our reply.",
        "updatedAt": "2013-09-07T13:37:00",
        "createdAt": "2013-09-07T13:37:00",
        "authorBusinessUserId": "507f191e810c19729de860ea"
      },
      "complianceLabels": [
        null
      ],
      "reportData": {
        "reasons": [
          null
        ],
        "source": "Trustpilot",
        "publicComment": "This review contains sensitive information.",
        "createdAt": "2013-09-07T13:37:00"
      },
      "language": "da",
      "countsTowardsTrustScore": false,
      "experiencedAt": "2013-09-07T13:37:00",
      "invitation": {
        "businessUnitId": "507f191e810c19729de860ea"
      },
      "consumer": {
        "displayLocation": "Frederiksberg, DK",
        "numberOfReviews": 1,
        "displayName": "John Doe",
        "id": "507f191e810c19729de860ea",
        "links": [
          {
            "href": "<Url for the resource>",
            "method": "<Http method for the resource>",
            "rel": "<Description of the relation>"
          }
        ]
      }
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}