Go To Top

Business Units API

This method shows all the reviews written about the business unit, including consumer email and Order ID.

GET
https://api.trustpilot.com/v1/private/business-units/{businessUnitId}/reviews
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/private/business-units/507f191e810c19729de860ea/reviews

stars, Optional Array
Filter by reviews with a specific number of stars.
Constraints: The allowed range is minimum: 1, maximum: 5
Example: ?stars=5

language, Optional Array
Filter by reviews with only a specific language.
Example: ?language=en

page, Optional Integer
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=1

internalLocationId, Optional String
Filter by reviews with a specific location.
Example: ?internalLocationId=1cd4d195-1f61-4c4c-8425-81385dd6e55a

perPage, Optional Integer
The number of reviews to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?perPage=3

orderBy, Optional Array
The order in which the results should be sorted. Valid values are: createdat.asc, createdat.desc, stars.asc and stars.desc
Default value: [ "createdat.desc" ]
Example: ?orderBy=createdat.asc

tagGroup, Optional String
Filtering reviews on Tag group
Example: ?tagGroup=Group Name

tagValue, Optional String
Filtering reviews on Tag value
Example: ?tagValue=Tag Name

ignoreTagValueCase, Optional Boolean
Ignore tag value case
Example: ?ignoreTagValueCase=true

responded, Optional Boolean
Filter reviews by responded state.
Example: ?responded=true

referenceId, Optional String
Filter reviews by reference Id.
Example: ?referenceId=1234

referralEmail, Optional String
Filter reviews by referral email.
Example: ?referralEmail=me@example.com

reported, Optional Boolean
Filter reviews by reported state.
Example: ?reported=true

startDateTime, Optional String
Filter reviews by datetime range. If no time is specified than time is implicit 00:00:00
Example: ?startDateTime=2013-09-07T13:37:00

endDateTime, Optional String
Filter reviews by datetime range. If no time is specified than time is implicit 00:00:00
Example: ?endDateTime=2013-09-07T13:37:00

source, Optional String
Filter reviews by source.
Example: ?source=Trustpilot

username, Optional String
Filter reviews by user name.
Example: ?username=Vlad

findReviewer, Optional String
Filter reviews by Find Reviewer requests (contacted or not contacted).
Example: ?findReviewer=notContacted

Response
{
  "reviews": [
    {
      "status": "active",
      "reportData": {
        "source": "Trustpilot",
        "publicComment": "This review contains sensitive information.",
        "createdAt": "2013-09-07T13:37:00",
        "reasons": [
          "sensitiveInformation",
          "consumerIsCompetitor"
        ],
        "reason": "consumer_is_competitor",
        "reviewVisibility": "hidden"
      },
      "findReviewer": {
        "isEligible": true,
        "requests": [
          {
            "id": "8e3a531e-f8e8-4d63-8d4c-187dc1408ed9",
            "created": "2013-09-07T13:37:00",
            "status": "Pending",
            "businessUserMessage": "Hi! We're having trouble finding you in our records, can you provide us with a reference number? Thanks!",
            "consumerResponse": {
              "submittedAt": "2013-09-07T13:37:00",
              "name": "John Doe",
              "email": "john.doe@gmail.com",
              "address": "123 Fake St.",
              "phoneNumber": "555-1234",
              "referenceId": "GZ12345",
              "message": "Hi, I've provided my reference number."
            }
          }
        ]
      },
      "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>"
          }
        ]
      },
      "location": {
        "id": "43f51215-a1fc-4c60-b6dd-e4afb6d7b831",
        "name": "Pilestraede 58",
        "urlFormattedName": "Pilestraede58",
        "externalId": "Location#123"
      },
      "text": "This shop is great.",
      "companyReply": {
        "text": "This is our reply.",
        "createdAt": "2013-09-07T13:37:00",
        "updatedAt": "2013-09-07T13:37:00"
      },
      "source": "Organic",
      "tags": [
        {
          "group": "Generic",
          "value": "Tag value"
        }
      ],
      "isVerified": true,
      "stars": 5,
      "updatedAt": "2013-09-07T13:37:00",
      "experiencedAt": "2013-09-07T13:37:00",
      "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",
      "complianceLabels": [
        null
      ],
      "countsTowardsTrustScore": false,
      "countsTowardsLocationTrustScore": false,
      "invitation": {
        "businessUnitId": "507f191e810c19729de860ea"
      },
      "businessUnitHistory": [
        {
          "businessUnitId": "507f191e810c19729de860ea",
          "identifyingName": "example.com",
          "displayName": "Example Inc.",
          "changeDate": "2013-09-07T13:37:00"
        }
      ],
      "reviewVerificationLevel": "invited"
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}

This method gets all the reviews written about the business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/reviews
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/507f191e810c19729de860ea/reviews

stars, Optional Array
Filter by reviews with a specific number of stars.
Constraints: The allowed range is minimum: 1, maximum: 5
Example: ?stars=5

language, Optional Array
Filter by reviews with only a specific language.
Example: ?language=en

internalLocationId, Optional String
Filter by reviews with only a specific location.
Example: ?internalLocationId=f994ac75-2f51-456a-9be9-ec30eadae778

page, Optional Integer
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=1

perPage, Optional Integer
The number of reviews to retrieve per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?perPage=3

orderBy, Optional Array
The order in which the results should be sorted. Valid values are: createdat.asc, createdat.desc, stars.asc and stars.desc
Default value: [ "createdat.desc" ]
Example: ?orderBy=stars.desc

tagGroup, Optional String
Filtering reviews on Tag group
Example: ?tagGroup=Group Name

tagValue, Optional String
Filtering reviews on Tag value
Example: ?tagValue=Tag Name

responded, Optional Boolean
Filter reviews by responded state.
Example: ?responded=true

includeReportedReviews, Optional Boolean
Include reported reviews.
Default value: false
Example: ?includeReportedReviews=true

Response
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "reviews": [
    {
      "id": "507f191e810c19729de860ea",
      "stars": 5,
      "title": "My review",
      "text": "This shop is great",
      "language": "da",
      "createdAt": "2013-09-07T13:37:00",
      "experiencedAt": "2013-09-06T13:37:00",
      "updatedAt": "2013-09-07T13:37:00",
      "numberOfLikes": 10,
      "isVerified": true,
      "status": "active",
      "invitation": {
        "businessUnitId": "507f191e810c19729de860eb"
      },
      "businessUnitHistory": [
        {
          "businessUnitId": "5f0c5e6108d8020001ee235d",
          "identifyingName": "merged-domain.com",
          "displayName": "Merged Domain",
          "changeDate": "2020-07-13T13:28:36.847Z"
        }
      ],
      "reviewVerificationLevel": "invited"
    }
  ]
}

Paginate through a business unit's reviews using a pageToken.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/all-reviews
Parameters
pageToken, Optional String
A previously returned page token representing part of the larger set of results to view.
Example: ?pageToken={pageToken}

businessUnitId, Required String

Example: …/v1/business-units/507f191e810c19729de860ea/all-reviews

Response
{
  "reviews": [
    {
      "id": null,
      "stars": 0,
      "title": null,
      "text": null,
      "language": null,
      "createdAt": null,
      "updatedAt": null,
      "experiencedAt": null,
      "isVerified": false,
      "companyReply": {
        "text": "This is our reply.",
        "createdAt": "2013-09-07T13:37:00",
        "updatedAt": "2013-09-07T13:37:00"
      },
      "consumer": {
        "displayLocation": "Frederiksberg DK",
        "displayName": "John Doe",
        "id": "507f191e810c19729de860ea"
      },
      "location": {
        "id": "43f51215-a1fc-4c60-b6dd-e4afb6d7b831",
        "name": "Pilestraede 58"
      }
    }
  ],
  "nextPageToken": "MjAxMy0wNS0wM1QxMDowMzo0MS4wMDBafDUxODM4YjdkMDAwMDY0MDAwMjQ0MTQyZA"
}

This method gets links to the business unit's public profile page on Trustpilot.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/web-links
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/web-links

locale, Required String
The locale to use when generating web links.
Example: ?locale={locale}

Response
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "locale": "da-DK",
  "profileUrl": "http://www.trustpilot.dk/review/www.trustpilot.com",
  "evaluateUrl": "http://www.trustpilot.dk/evaluate/www.trustpilot.com",
  "evaluateEmbedUrl": "http://www.trustpilot.dk/evaluate/embed/www.trustpilot.com"
}

Get the company header for a specific business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/images/header
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/images/header

Response
{
  "headerUrl": null
}

Get the company logo for a specific business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/images/logo
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/images/logo

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

Get the company promotion box for a specific business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/images/promotion-box
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/images/promotion-box

Response
{
  "promotionBoxUrl": null
}

Get the company profile image for a specific business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/images
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/images

Response
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "profileImage": {
    "image57x43": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image118x89": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    },
    "image198x149": {
      "url": "<Url for the image>",
      "width": "<Image width>",
      "height": "<Image height>"
    }
  }
}

Get company profile information for a specific business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/profileinfo
Parameters
businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/{businessUnitId}/profileinfo

Response
{
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ],
  "isSubscriber": true,
  "email": "john@trustpilot.com",
  "phone": "+45 11 22 33 44",
  "companyName": "Trustpilot",
  "address": {
    "street": "Sesame street, 1",
    "city": "The Shire",
    "postcode": "WD24 7NE",
    "country": "UK",
    "countryCode": "UK"
  },
  "description": {
    "header": "About Trustpilot",
    "text": "Trustpilot is a review platform."
  },
  "socialmedia": {
    "facebook": null,
    "linkedin": null,
    "twitter": null,
    "googleplus": null,
    "youtube": null,
    "instagram": null
  },
  "facebookPageId": 123456789,
  "facebookPageUrl": "https://www.facebook.com/facebook",
  "isFacebookActivated": true,
  "isCommentsEnabled": true,
  "isIncentivisingUsers": false,
  "isClaimed": true
}

Get a list of categories for a business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/categories
Parameters
businessUnitId, Required String
The id of the business unit to list categories for.
Example: …/v1/business-units/4bf2b69100006400050ce5ee/categories

country, Optional String
Specify country using ISO 3166-1-alpha-2.
Example: ?country=US

locale, Optional String
The locale to get translated category names for.
Default value: en-US
Example: ?locale=en-US

Response
{
  "categories": [
    {
      "categoryId": "pet_store",
      "displayName": "Pet Store",
      "name": "pet_store",
      "isPrimary": true,
      "ranking": {
        "position": 1,
        "cardinality": 13
      },
      "source": "business",
      "relevance": 1
    }
  ],
  "predictedTopCategory": {}
}

This method searches for business units, even if you only know part of the name. For example, search results for "Trustpilot" would show "trustpilot.com", among others.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/search
Parameters
query, Required String
The search term to use. This will be used to search for identifying name and referring names.
Example: ?query={query}

country, Optional String
The 2 letter country code for the preferred country code
Example: ?country={country}

page, Optional Integer
The page to retrieve. If the page number requested is higher than the available number of pages an empty array will be returned.
Constraints: The allowed range is minimum: 1, maximum: 2147483647
Default value: 1
Example: ?page=0

perpage, Optional Integer
The number of results to display per page.
Constraints: The allowed range is minimum: 1, maximum: 100
Default value: 20
Example: ?perpage=0

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