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

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

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

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

businessUnitId, Required String
The id of the business unit.
Example: …/v1/private/business-units/507f191e810c19729de860ea/reviews

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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
The name of the business unit to match.
Example: ?name={name}

Response
{
  "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"
  }
}

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

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

businessUnitId, Required String
The id of the business unit.
Example: …/v1/business-units/507f191e810c19729de860ea/reviews

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

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

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

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

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

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

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

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

Response
{
  "reviews": [
    {
      "status": "active",
      "language": "da",
      "title": "My review",
      "text": "This shop is great",
      "invitation": {
        "businessUnitId": "507f191e810c19729de860eb"
      },
      "isVerified": true,
      "stars": 5,
      "updatedAt": "2013-09-07T13:37:00",
      "numberOfLikes": 10,
      "id": "507f191e810c19729de860ea",
      "createdAt": "2013-09-07T13:37:00"
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}

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
locale, Required String
The locale to use when generating web links.
Example: ?locale={locale}

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

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

Page all business units, including the ones without reviews.

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

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

Response
{
  "businessUnits": [
    {
      "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"
      }
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}

This method gets a list of all the business units with minimum one review.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units
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

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

Response
{
  "businessUnits": [
    {
      "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"
      }
    }
  ],
  "links": [
    {
      "href": "<Url for the resource>",
      "method": "<Http method for the resource>",
      "rel": "<Description of the relation>"
    }
  ]
}

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

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

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

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

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

Get a list of categories for a business unit.

GET
Authentication: API Key
https://api.trustpilot.com/v1/business-units/{businessUnitId}/categories
Parameters
locale, Optional String
The locale to get translated category names for.
Default value: en-US
Example: ?locale=da-DK

businessUnitId, Required String
The id of the business unit to list categories for.
Example: …/v1/business-units/507f191e810c19729de860ea/categories

Response
{
  "categories": [
    {
      "ranking": {
        "position": 3,
        "cardinality": 12
      },
      "isPrimary": false,
      "displayName": "Art supplies",
      "categoryId": "507f191e810c19729de860ea",
      "name": "art-supplies"
    }
  ]
}

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}

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

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

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

Response
{
  "businessUnits": [
    {
      "link": [
        {
          "href": null,
          "method": null,
          "rel": null
        }
      ],
      "displayName": null,
      "id": null,
      "name": {
        "referring": [
          null
        ],
        "identifying": null
      }
    }
  ],
  "links": [
    {
      "href": null,
      "method": null,
      "rel": null
    }
  ]
}