Go To Top

Service Reviews API

This method will add tags to a service review. To see your tags in Trustpilot Business, use "group": "Generic" when making your requests.

PUT
https://api.trustpilot.com/v1/private/reviews/{reviewId}/tags
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/private/reviews/507f191e810c19729de860ea/tags

Request
{
  "sourceSystem": "businessapp",
  "sourceUser": "507f191e810c19729de860ea",
  "tags": [
    {
      "group": "ProductGroup",
      "value": "Computers"
    }
  ]
}

This method will delete a reply to a review.

DELETE
https://api.trustpilot.com/v1/private/reviews/{reviewId}/reply
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/private/reviews/507f191e810c19729de860ea/reply


This method gets the reviews's public information(stars, text, consumer, etc.).

GET
Authentication: API Key
https://api.trustpilot.com/v1/reviews/{reviewId}
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/reviews/507f191e810c19729de860ea

Response
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "language": "da",
  "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",
  "companyReply": {
    "text": "This is our reply.",
    "createdAt": "2013-09-07T13:37:00"
  },
  "isVerified": true,
  "stars": 5,
  "updatedAt": "2013-09-07T13:37:00",
  "complianceLabels": [
    null
  ],
  "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",
  "createdAt": "2013-09-07T13:37:00"
}

This method gets the list of consumers who have liked the review

GET
Authentication: API Key
https://api.trustpilot.com/v1/reviews/{reviewId}/likes
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/reviews/507f191e810c19729de860ea/likes

Response
{
  "likes": [
    {
      "consumer": {
        "displayName": "John Doe",
        "id": "507f191e810c19729de860ea"
      }
    }
  ]
}

This method gets links to a review's public page on Trustpilot.

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

locale, Required String
The locale of the links.
Example: ?locale=en-GB

Response
{
  "locale": null,
  "reviewUrl": null,
  "links": {
    "href": "<Url for the resource>",
    "method": "<Http method for the resource>",
    "rel": "<Description of the relation>"
  }
}

This method gets the latest reviews written in a specfic language.

GET
Authentication: API Key
https://api.trustpilot.com/v1/reviews/latest
Parameters
count, Required Integer
The number of reviews to retrieve.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?count=3

filterUsersWithoutImages, Optional Boolean
Used to filter reviews with users that they do not have an image.
Example: ?filterUsersWithoutImages=true

language, Required Array
Filter by specific languages.
Example: ?language=en

locale, Optional String
Used to create links using this locale.
Example: ?locale=en-GB

Response
{
  "reviews": [
    {
      "language": "da",
      "links": [
        {
          "href": "<Url for the resource>",
          "method": "<Http method for the resource>",
          "rel": "<Description of the relation>"
        }
      ],
      "title": "My review",
      "businessUnit": {
        "displayName": "Trustpilot",
        "id": "507f191e810c19729de860ea",
        "links": [
          {
            "href": "<Url for the resource>",
            "method": "<Http method for the resource>",
            "rel": "<Description of the relation>"
          }
        ],
        "name": {
          "referring": [
            "trustpilot.com",
            "www.trustpilot.com"
          ],
          "identifying": "trustpilot.com"
        }
      },
      "text": "This shop is great.",
      "updatedAt": "2013-09-07T13:37:00",
      "createdAt": "2013-09-07T13:37:00",
      "stars": 5,
      "companyReply": {
        "text": "This is our reply.",
        "createdAt": "2013-09-07T13:37:00"
      },
      "consumer": {
        "profileUrl": "http://www.trustpilot.com/users/55cc4f3b0000fe0002c4f125",
        "profileImage": {
          "image35x35": {
            "url": "<Url for the image>",
            "width": "<Image width>",
            "height": "<Image height>"
          },
          "image24x24": {
            "url": "<Url for the image>",
            "width": "<Image width>",
            "height": "<Image height>"
          },
          "image73x73": {
            "url": "<Url for the image>",
            "width": "<Image width>",
            "height": "<Image height>"
          },
          "image64x64": {
            "url": "<Url for the image>",
            "width": "<Image width>",
            "height": "<Image height>"
          }
        },
        "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
    }
  ]
}

This method gets the reviews's basic public information but also some private information (referenceEmail and referenceId) and status as either "active" or "reported".

GET
https://api.trustpilot.com/v1/private/reviews/{reviewId}
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/private/reviews/507f191e810c19729de860ea

Response
{
  "status": "active",
  "referenceId": "12345",
  "referralEmail": "my@email.com",
  "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.",
  "tags": [
    {
      "group": "Generic",
      "value": "Tag value"
    }
  ],
  "complianceLabels": [
    null
  ],
  "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>"
      }
    ]
  },
  "countsTowardsTrustScore": false,
  "source": "Organic",
  "createdAt": "2013-09-07T13:37:00",
  "stars": 5,
  "companyReply": {
    "text": "This is our reply.",
    "createdAt": "2013-09-07T13:37:00"
  },
  "updatedAt": "2013-09-07T13:37:00",
  "reportData": {
    "source": "Trustpilot",
    "publicComment": "This review contains sensitive information.",
    "createdAt": "2013-09-07T13:37:00"
  },
  "numberOfLikes": 10,
  "id": "507f191e810c19729de860ea",
  "isVerified": true
}

This method gets a list of all the tags on a service review.

GET
https://api.trustpilot.com/v1/private/reviews/{reviewId}/tags
Parameters
reviewId, Required String
The Id of the review to get tags for.
Example: …/v1/private/reviews/507f191e810c19729de860ea/tags

Response
{
  "tags": [
    {
      "group": "ProductGroup",
      "value": "Computers"
    }
  ]
}

This method gets a list of the tags on a service review by their group.

GET
https://api.trustpilot.com/v1/private/reviews/{reviewId}/tags/{group}
Parameters
reviewId, Required String
The Id of the review to get tags for.
Example: …/v1/private/reviews/507f191e810c19729de860ea/tags/{group}

group, Required String
The name of the group to get tags for.
Example: …/v1/private/reviews/{reviewId}/tags/ProductGroup

Response
{
  "tags": [
    {
      "group": "ProductGroup",
      "value": "Computers"
    }
  ]
}

This method will remove a tag from a service review.

DELETE
https://api.trustpilot.com/v1/private/reviews/{reviewId}/tags
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/private/reviews/507f191e810c19729de860ea/tags

group, Required String

Example: ?group=ProductGroup

value, Required String

Example: ?value=Computers


This method will post a reply to a review.

POST
https://api.trustpilot.com/v1/private/reviews/{reviewId}/reply
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/private/reviews/507f191e810c19729de860ea/reply

Request
{
  "message": "Reply message"
}

This method will set the tags of a service review. To see your tags in Trustpilot Business, use "group": "Generic" when making your requests.

POST
https://api.trustpilot.com/v1/private/reviews/{reviewId}/tags
Parameters
reviewId, Required String
The id of the review.
Example: …/v1/private/reviews/507f191e810c19729de860ea/tags

Request
{
  "tags": [
    {
      "group": "ProductGroup",
      "value": "Computers"
    }
  ]
}

This method sets all the service review's tags of a specific group. If the group does not exist, it will be created. To see your tags in Trustpilot Business, use "group": "Generic" when making your requests.

PUT
https://api.trustpilot.com/v1/private/reviews/{reviewId}/tags/{group}
Parameters
reviewId, Required String
The Id of the review to get tags for.
Example: …/v1/private/reviews/507f191e810c19729de860ea/tags/{group}

group, Required String
The name of the group to set tags for.
Example: …/v1/private/reviews/{reviewId}/tags/ProductGroup

Request
{
  "tags": [
    null
  ]
}