Business Units API (public)

Find a business unit

Returns the business unit given by the provided name

GET

Authentication: API Key

https://api.trustpilot.com/v1/business-units/find

Parameters

name, Required String

Example: ?name={name}

Response

{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "id": "507f191e810c19729de860ea",
  "displayName": "Trustpilot",
  "name": {
    "identifying": "trustpilot.com",
    "referring": [
      "trustpilot.com",
      "www.trustpilot.com"
    ]
  },
  "websiteUrl": "http://www.trustpilot.com",
  "country": "DK",
  "numberOfReviews": {
    "total": 14,
    "usedForTrustScoreCalculation": 12,
    "oneStar": 2,
    "twoStars": 3,
    "threeStars": 2,
    "fourStars": 5,
    "fiveStars": 2
  },
  "status": "active",
  "score": {
    "trustScore": 4.6,
    "stars": 4.5
  },
  "badFit": true
}

Get a list of all business units

Page all business units, including the ones without reviews. Use cursor value from previous response to get the next page of results.

GET

Authentication: API Key

https://api.trustpilot.com/v1/business-units/all

Parameters

country, Optional Array
Filter by specific countries using ISO 3166-1-alpha-2.
Example: ?country={country}
* provide multiple values using comma seperation

perPage, Optional Integer
The number of business units to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 1000
Default value: 1000
Example: ?perPage=0

cursor, Optional String
The cursor values from the previous page response used to retrieve the next page of results.
Example: ?cursor={cursor}

Response

{
  "businessUnits": [
    {
      "id": "507f191e810c19729de860ea",
      "displayName": "Trustpilot",
      "name": {
        "identifying": "trustpilot.com",
        "referring": [
          "trustpilot.com",
          "www.trustpilot.com"
        ]
      },
      "links": [
        {
          "href": "<Url for the resource>",
          "method": "<Http method for the resource>",
          "rel": "<Description of the relation>"
        }
      ]
    }
  ],
  "cursor": null,
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}

Get customer guarantee of business unit

Get the company's Guarantee Box information for a specific business unit.

GET

Authentication: API Key

https://api.trustpilot.com/v1/business-units/{businessUnitId}/customerguarantee

Parameters

businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/customerguarantee

Response

{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "header": "Guarantee box",
  "teaser": "This is what we promise",
  "body": "We will do our best to deliver quality service.",
  "display": true,
  "image": {
    "image184x0": {
      "url": "<Url for the image>",
      "width": "<Image width>"
    }
  }
}

Get profile promotion of business unit

Get the company's Promotion Box information for a specific business unit.

GET

Authentication: API Key

https://api.trustpilot.com/v1/business-units/{businessUnitId}/profilepromotion

Parameters

businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/profilepromotion

Response

{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "title": "Trustpilot",
  "contactInfoTitle": "Trustpilot Support Team",
  "description": {
    "header": "About Trustpilot",
    "text": "Trustpilot is a review platform."
  },
  "sellingPoints": [
    {
      "header": "Trustpilot's commitment",
      "text": "Trustpilot is committed to ensuring better online shopping experiences for everyone."
    }
  ],
  "image": {
    "url": "<Url for the image>",
    "width": "<Image width>"
  }
}

Get profile promotion of business unit

Get the company's Promotion Box information for a specific business unit.

GET

Authentication: API Key

https://api.trustpilot.com/v1/business-units/{businessUnitId}/promotion-box

Parameters

businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/promotion-box

Response

{
  "header": "Promotion header",
  "message": "Promotion header description",
  "textColor": "#000",
  "backgroundColor": "#87BBA7",
  "buttonText": "#fff",
  "buttonColor": "#ccc",
  "buttonTextColor": "#fff",
  "buttonLink": "http://www.trustpilot.com",
  "imageUrl": "path-to-s3-object.com",
  "isPublished": false
}

Get public business unit

This method gets the business unit's basic public information (name, URL, reviews, etc.).

GET

Authentication: API Key

https://api.trustpilot.com/v1/business-units/{businessUnitId}

Parameters

businessUnitId, Required String

Example: …/v1/business-units/{businessUnitId}

Response

{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "id": "507f191e810c19729de860ea",
  "displayName": "Trustpilot",
  "name": {
    "identifying": "trustpilot.com",
    "referring": [
      "trustpilot.com",
      "www.trustpilot.com"
    ]
  },
  "websiteUrl": "http://www.trustpilot.com",
  "country": "DK",
  "numberOfReviews": {
    "total": 14,
    "usedForTrustScoreCalculation": 12,
    "oneStar": 2,
    "twoStars": 3,
    "threeStars": 2,
    "fourStars": 5,
    "fiveStars": 2
  },
  "status": "active",
  "score": {
    "trustScore": 4.6,
    "stars": 4.5
  },
  "badFit": true
}