Skip to content

Business Units API (public)

  • Get public business unit

    Returns a business unit's public information including name, url and reviews.

    HTTP method: GET

    Authentication: API Key

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

    Parameters

    • businessUnitId, Required string

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


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

    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
    }
  • Find a business unit

    Returns publicly available information for a business unit, based on the domain name.

    HTTP method: GET

    Authentication: API Key

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

    Parameters

    • name, Required string

      Example: ?name={name}


    curl -X GET "https://api.trustpilot.com/v1/business-units/find" \
    -G \
    --data-urlencode "name=example" \
    -H "apikey: YOUR-API-KEY-HERE"

    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

    Returns all business units, including domains with no reviews. By default, each page returns 100 results, use the cursor value to navigate through pages.

    HTTP method: GET

    Authentication: API Key

    URL: 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}


    • perPage, Optional integer

      The number of business units to retrieve per page.

      Example: ?perPage={perPage}


    • cursor, Optional string

      The cursor values from the previous page response used to retrieve the next page of results.

      Example: ?cursor={cursor}


    curl -X GET "https://api.trustpilot.com/v1/business-units/all" \
    -H "apikey: YOUR-API-KEY-HERE"

    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.

    HTTP method: GET

    Authentication: API Key

    URL: 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


    curl -X GET "https://api.trustpilot.com/v1/business-units/{businessUnitId}/customerguarantee" \
    -H "apikey: YOUR-API-KEY-HERE"

    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 key brand messages content for a business unit

    Get Promotion Box with key brand messages content for a specific business unit.

    HTTP method: GET

    Authentication: API Key

    URL: 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


    curl -X GET "https://api.trustpilot.com/v1/business-units/{businessUnitId}/profilepromotion" \
    -H "apikey: YOUR-API-KEY-HERE"

    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 special deals content for a business unit

    Get current special deals Promotion Box content for a specific business unit.

    HTTP method: GET

    Authentication: API Key

    URL: 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


    curl -X GET "https://api.trustpilot.com/v1/business-units/{businessUnitId}/promotion-box" \
    -H "apikey: YOUR-API-KEY-HERE"

    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
    }