Go To Top

Consumer API

This method gets the reviews written by the individual consumer.

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}/reviews
Parameters
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

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

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

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

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

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

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

Response
{
  "reviews": [
    {
      "status": "active",
      "reportData": {
        "source": "Trustpilot",
        "publicComment": "This review contains sensitive information.",
        "createdAt": "2013-09-07T13:37:00"
      },
      "language": "da",
      "links": [
        {
          "href": "<Url for the resource>",
          "method": "<Http method for the resource>",
          "rel": "<Description of the relation>"
        }
      ],
      "title": "My review",
      "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>"
          }
        ]
      },
      "text": "This shop is great.",
      "updatedAt": "2013-09-07T13:37:00",
      "countsTowardsTrustScore": false,
      "createdAt": "2013-09-07T13:37:00",
      "stars": 5,
      "companyReply": {
        "text": "This is our reply.",
        "createdAt": "2013-09-07T13:37:00"
      },
      "numberOfLikes": 10,
      "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>"
          }
        ]
      },
      "id": "507f191e810c19729de860ea",
      "isVerified": true
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}

Gets a list of consumer profiles

POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/bulk
Parameters
No parameters required
Request
{
  "consumerIds": [
    "id1",
    "id2"
  ]
}
Response
{
  "notFoundConsumerIds": [
    "not_found_id"
  ],
  "consumers": {}
}

Gets the profile information of the consumer

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}/profile
Parameters
consumerId, Required String
Id of the consumer
Example: …/v1/consumers/507f191e810c19729de860ea/profile

Response
{
  "city": "Copenhagen",
  "about": "I'm the greatest of all Does",
  "displayName": "Jane Doe",
  "locale": "da-DK",
  "gender": "Female",
  "profileImage": {
    "image35x35": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image64x64": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image73x73": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image24x24": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    }
  },
  "birthYear": 1980,
  "country": "DK",
  "id": "507f191e810c19729de860ea",
  "createdAt": "2013-09-07T13:37:00",
  "hasImage": true
}

Gets the profile information of the consumer along with the number of reviews

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}
Parameters
consumerId, Required String
Id of the consumer
Example: …/v1/consumers/507f191e810c19729de860ea

Response
{
  "city": "Copenhagen",
  "about": "I'm the greatest of all Does",
  "displayName": "Jane Doe",
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "locale": "da-DK",
  "country": "DK",
  "profileImage": {
    "image35x35": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image64x64": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image73x73": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image24x24": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    }
  },
  "birthYear": 1980,
  "numberOfReviews": 1338,
  "gender": "Female",
  "id": "507f191e810c19729de860ea",
  "createdAt": "2013-09-07T13:37:00",
  "hasImage": true
}

Gets the consumer's web profile links(web and api)

GET
Authentication: API Key
https://api.trustpilot.com/v1/consumers/{consumerId}/web-links
Parameters
consumerId, Required String
The id of the consumer.
Example: …/v1/consumers/507f191e810c19729de860ea/web-links

locale, Required String
The locale to use when generating web links.
Example: ?locale=en-US

Response
{
  "locale": "en-US",
  "profileUrl": "https://www.trustpilot.com/users/89724662348762929907",
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}