Consumer Profile API

Get the profile of the consumer

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

HTTP method: GET

Authentication: API Key

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

Parameters

• consumerId, Required string

  Example: .../v1/consumers/{consumerId}/profile

---

curl -X GET "https://api.trustpilot.com/v1/consumers/{consumerId}/profile" \
  -H "apikey: YOUR-API-KEY-HERE"

{
  "city": "New York",
  "about": "A brief description about the consumer",
  "displayName": "John Doe",
  "locale": "en-US",
  "gender": "male",
  "country": "US",
  "id": "1234567890",
  "createdAt": "2023-01-01T12:00:00Z",
  "hasImage": false,
  "birthYear": 0,
  "profileImage": {
    "image24x24": {
      "url": null,
      "width": 0,
      "height": 0
    },
    "image35x35": {
      "url": null,
      "width": 0,
      "height": 0
    },
    "image64x64": {
      "url": null,
      "width": 0,
      "height": 0
    },
    "image73x73": {
      "url": null,
      "width": 0,
      "height": 0
    }
  }
}

Get the profile of the consumer(with #reviews and weblinks)

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

HTTP method: GET

Authentication: API Key

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

Parameters

• consumerId, Required string

  Example: .../v1/consumers/{consumerId}

---

curl -X GET "https://api.trustpilot.com/v1/consumers/{consumerId}" \
  -H "apikey: YOUR-API-KEY-HERE"

{
  "numberOfReviews": 0,
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ],
  "city": "New York",
  "about": "A brief description about the consumer",
  "displayName": "John Doe",
  "locale": "en-US",
  "gender": "male",
  "country": "US",
  "id": "1234567890",
  "createdAt": "2023-01-01T12:00:00Z",
  "hasImage": false,
  "birthYear": 0,
  "profileImage": {
    "image24x24": {
      "url": null,
      "width": 0,
      "height": 0
    },
    "image35x35": {
      "url": null,
      "width": 0,
      "height": 0
    },
    "image64x64": {
      "url": null,
      "width": 0,
      "height": 0
    },
    "image73x73": {
      "url": null,
      "width": 0,
      "height": 0
    }
  }
}

Get a list of consumer profiles

Gets a list of consumer profiles

HTTP method: POST

Authentication: API Key

URL: https://api.trustpilot.com/v1/consumers/profile/bulk

Parameters

No parameters required

curl -X POST "https://api.trustpilot.com/v1/consumers/profile/bulk" \
  -H "Content-Type: application/json" \
  -d '{
    "consumerIds": [
      "example"
    ]
  }' \
  -H "apikey: YOUR-API-KEY-HERE"

{
  "consumerIds": [
    null
  ]
}

{
  "consumers": {},
  "notFoundConsumerIds": [
    null
  ]
}

Create a valid consumer display name from input string

Create a valid consumer display name from input string

HTTP method: POST

Authentication: API Key

URL: https://api.trustpilot.com/v1/consumers/profile/displayname/create

Parameters

No parameters required

curl -X POST "https://api.trustpilot.com/v1/consumers/profile/displayname/create" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "example"
  }' \
  -H "apikey: YOUR-API-KEY-HERE"

{
  "displayName": null
}

null

Validate consumer display name

Validate consumer display name

HTTP method: POST

Authentication: API Key

URL: https://api.trustpilot.com/v1/consumers/profile/displayname/validate

Parameters

No parameters required

curl -X POST "https://api.trustpilot.com/v1/consumers/profile/displayname/validate" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "example"
  }' \
  -H "apikey: YOUR-API-KEY-HERE"

{
  "displayName": null
}

Get the profile of the consumer

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

HTTP method: GET

Authentication: API Key

URL: https://api.trustpilot.com/v1/consumers/{consumerId}/web-links

Parameters

• locale, Optional string

  The locale to use when generating web links.

  Example: ?locale={locale}

---

• consumerId, Required string

  Example: .../v1/consumers/{consumerId}/web-links

---

curl -X GET "https://api.trustpilot.com/v1/consumers/{consumerId}/web-links" \
  -H "apikey: YOUR-API-KEY-HERE"

{
  "locale": null,
  "profileUrl": null,
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ]
}