Go To Top

Categories API

Get details of a specific category by its name.

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

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

name, Required String
The system name of the category to get details about.
Example: ?name=art-supplies

Response
{
  "businessUnitCount": 42,
  "parentId": "507f191e810c19729de860ea",
  "displayName": "Art supplies",
  "categoryId": "507f191e810c19729de860ea",
  "name": "art-supplies"
}

Get details of a specific category.

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

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

categoryId, Required String
The id of the category to get details about.
Example: …/v1/categories/507f191e810c19729de860ea

Response
{
  "businessUnitCount": 42,
  "parentId": "507f191e810c19729de860ea",
  "displayName": "Art supplies",
  "categoryId": "507f191e810c19729de860ea",
  "name": "art-supplies"
}

Get a ranked list of business units in a specific category.

GET
Authentication: API Key
https://api.trustpilot.com/v1/categories/{categoryId}/business-units
Parameters
country, Required String
Specify country using ISO 3166-1-alpha-2.
Example: ?country=DK

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

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

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
{
  "businessUnits": [
    {
      "displayName": "Example Shop Ltd.",
      "businessUnitId": "507f191e810c19729de860ea",
      "rank": 8,
      "numberOfReviews": 105,
      "identifyingName": "example.com",
      "trustScore": 82
    }
  ]
}

Get a list of categories under a specific parent category.

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

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

parentId, Optional String
Optional id of a parent category to list children of.
Example: ?parentId=507f191e810c19729de860ea

Response
{
  "categories": [
    {
      "displayName": "Art supplies",
      "categoryId": "507f191e810c19729de860ea",
      "name": "art-supplies"
    }
  ]
}

Get details of a specific category by its name.

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

query, Required String
The system name of the category to get details about.
Example: ?query=art-supplies

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

Response
{
  "categories": [
    {
      "displayName": "Art supplies",
      "categoryId": "507f191e810c19729de860ea",
      "name": "art-supplies"
    }
  ]
}