Go To Top

consumeraccount

Gets a list of consumer profiles

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

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
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": null,
  "profileUrl": null,
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ]
}

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": null,
  "about": null,
  "displayName": null,
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ],
  "locale": null,
  "country": null,
  "profileImage": {
    "image35x35": {
      "url": null,
      "width": null,
      "height": null
    },
    "image64x64": {
      "url": null,
      "width": null,
      "height": null
    },
    "image73x73": {
      "url": null,
      "width": null,
      "height": null
    },
    "image24x24": {
      "url": null,
      "width": null,
      "height": null
    }
  },
  "birthYear": 0.0,
  "numberOfReviews": 0.0,
  "gender": null,
  "id": null,
  "createdAt": null,
  "hasImage": false
}

Gets the profile information of the consumer. NOTE: birthYear and createdAt result values are obsolete.

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": null,
  "about": null,
  "displayName": null,
  "locale": null,
  "country": null,
  "profileImage": {
    "image35x35": {
      "url": null,
      "width": null,
      "height": null
    },
    "image64x64": {
      "url": null,
      "width": null,
      "height": null
    },
    "image73x73": {
      "url": null,
      "width": null,
      "height": null
    },
    "image24x24": {
      "url": null,
      "width": null,
      "height": null
    }
  },
  "birthYear": 0.0,
  "gender": null,
  "id": null,
  "createdAt": null,
  "hasImage": false
}