Consumer Profile API
Create a valid consumer display name from input string
POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/displayname/create
Parameters
No parameters required
Request
{ "displayName": null }
Gets a list of consumer profiles
POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/bulk
Parameters
No parameters required
Request
{ "consumerIds": [ "507f191e810c19729de860ea" ] }
Response
{ "consumers": {}, "notFoundConsumerIds": [ "507f191e810c19729de860ea" ] }
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
Id of the consumer
Example: …/v1/consumers/507f191e810c19729de860ea/profile
Response
{ "city": "Copenhagen", "about": "I'm a Trustpilot user", "displayName": "Jane Doe", "locale": "da-DK", "gender": "Female", "country": "DK", "id": "507f191e810c19729de860ea", "createdAt": "2013-09-07T13:37:00", "hasImage": true, "birthYear": 0, "profileImage": { "image24x24": { "url": "<Url for the image>", "width": "<Image width>", "height": "<Image height>" }, "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>" } } }
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
Id of the consumer
Example: …/v1/consumers/507f191e810c19729de860ea
Response
{ "city": "Copenhagen", "about": "I'm a Trustpilot user", "displayName": "Jane Doe", "locale": "da-DK", "gender": "Female", "country": "DK", "id": "507f191e810c19729de860ea", "createdAt": "2013-09-07T13:37:00", "hasImage": true, "birthYear": 0, "numberOfReviews": 1337, "links": [ { "href": "<Url for the resource>", "method": "<Http method for the resource>", "rel": "<Description of the relation>" } ], "profileImage": { "image24x24": { "url": "<Url for the image>", "width": "<Image width>", "height": "<Image height>" }, "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>" } } }
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
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
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>" } ] }
Validate consumer display name
POST
Authentication: API Key
https://api.trustpilot.com/v1/consumers/profile/displayname/validate
Parameters
No parameters required
Request
{ "displayName": null }