developers.trustpilot.comTrustpilot API Documentation

Go To Top Overview Introduction Authentication FAQ Business Units API Business unit private reviews Get a business unit's reviews Get business unit company logo Get customer guarantee of business unit Get images of business unit Get profile info of business unit Get profile promotion of business unit List categories for business unit Search for business units Business Units Legacy API Find a business unit Get a business unit's web links Get a list of all business units Get a list of business units Get public business unit Categories API Get category List business units in category List categories Consumer API Get a consumer's reviews Consumer Profile API Get a list of consumer profiles Get the profile of the consumer Get the profile of the consumer(with #reviews and weblinks) Get the web links of the consumer Invitation API Create invitation(s) Delete invitation data Generate service review invitation link Get list of invitation templates Private Products API Batch upsert products Get products Product Reviews API Create comment Create product review conversation Create product review invitation link Get batch product reviews summaries Get comment Get conversation Get imported product reviews Get imported product reviews summary Get private product review Get private product reviews Get product reviews Get product reviews summaries list Get product reviews summary Get public batch aggregated attribute rating summaries Get public conversation Set conversation state Resources API Contains navigational links to all image resources Get all countries known to Trustpilot Get the star image resources Get the string representation of the stars Get the Trustpilot icon images Get the Trustpilot logo images Get Trustpilot supported locales Service Reviews API Add tags to a review Create Find Reviewer request for a review Delete a reply to a review Get a review Get a review's likes Get a review's web links Get latest reviews by language Get private review Get tags on review Remove a tag from a review Reply to a review. Set tags on review Introduction Welcome to the documentation for Trustpilot Public and Customer APIs. Here you will find all required details on our APIs, including technical concepts and formats, authentication methods, error codes and FAQs. The Public API provides you access to content available to the public on trustpilot.com. The Customer API provides access to features of our Business product available to merchants using Trustpilot. We use the exact same APIs for building our public website and business product, meaning that the APIs are highly available and that we are committed to their continued improvement and evolution. Business Unit Concept Trustpilot uses the business unit concept as the collection point for all Trustpilot content for a website. The business unit hosts a company's rating, its reviews, and the company responses. A business unit has a unique ID, and is used throughout the APIs. A business unit refers to one main domain name (primary name), and it can be associated with other domain names or sub-domains (referral names). Trustpilot uses the business unit concept as the collection point for all Trustpilot content for a website; it hosts a company's rating, its reviews, and the company responses. A business user can access one or many business units. Figuring out your Business Unit ID For almost any integration, the first step is getting your Business Unit ID. The Business Unit ID is a unique key to your domain. If you collect reviews under multiple domains, each one will have its own Business Unit ID. To find your Business Unit ID(s) please use the Find Business Unit API . Authentication The Public API does not require authentication, as you simply need to pass your API key for each request. This key must be added to all calls: either as a query parameter, i.e.: ?apikey={key} or an HTTP header, i.e.: apikey:{key} The Customer API uses OAuth v2 with refresh. See the Authentication page for full details. Schema All API requests must be made over HTTPS. Empty values are included as null rather than omitted. All date/time responses are returned using ISO 8601 format using UTC. Data Formats The API currently supports JSON as request and response format, and Cross-Origin Resource Sharing policy is enabled for Get requests. As an alternative solution to same origin policy limitations, requests can be made to return JSONP, by adding a query parameter called callback with the name of the JavaScript function to wrap the data, e.g.: ?callback=execute Cache Some results are cached on our API servers. Cached results will also include HTTP header information about client cacheability. Rate Limiting guidelines While we do not publish a rate limiting policy, we do have certain limits to the usage of the APIs. For normal use cases this will not be an issue, but we will make sure that if our APIs are called at a more than reasonable rate, certain limits will apply. Tips to avoid rate limiting Do not constantly pull data and instead use webhooks. Learn more about how to set up Trustpilot's webhooks to get instant notifications about events such as new reviews, deleted reviews or revised reviews. Rather than generate an OAuth 2.0 access token for each transaction, reuse the valid token. See authentication guidelines to learn more. Make sure that you are not calling Trustpilot APIs each time the front-end of your website is loaded. If you want to display reviews or ratings on your site, make sure that data is stored in your own backend and updated regularly, preferably using webhooks. Trustpilot Community Business Blog Press Jobs Apps Developers Support Follow us on About us Founded by a passionate team of international entrepreneurs, Trustpilot exists today to deliver top notch customer experiences via our community driven review platform. We help companies proactively collect reviews and get real insight straight from the people who matter most, their customers. © 2015 Trustpilot, Inc. All rights reserved....