This endpoint returns all brands from Passport that your subscription has access to. Each brand is associated with a parent company. Results are paginated and can optionally be filtered by geography and category.
| URI | https://api.euromonitor.com/passport-catalog/brand | |
| Supported verbs | GET | |
| Required headers | Ocp-Apim-Subscription-Key, Accept, Authorization | |
| Supported formats | JSON, XML, CSV | |
| Parameters | ||
| Format | Optional | Response format: json, csv, or xml. Defaults to json if not specified |
| PageNumber | Optional | Page number for pagination (starts at 1). Defaults to 1 if not specified |
| NoOfRecords | Optional | Number of records to return per page (max 10000). Defaults to 10000 if not specified |
| GeographyIds | Optional | A list of geography IDs to filter results by |
| CategoryIds | Optional | A list of category IDs to filter results by |
| IndustryCodes | Optional | A list of industry codes to filter results by |
A sample GET request might look like this:
GET https://api.euromonitor.com/passport-catalog/brand?PageNumber=1&NoOfRecords=100&GeographyIds=1,2&CategoryIds=101 HTTP/1.1
Host: api.euromonitor.com
Authorization: Bearer <tokenstring>
Accept: application/json; api-version=1.0
Ocp-Apim-Subscription-Key: 173bad6f0b319h23add9ad162493915e
A successful response body will have the following structure in JSON format:
{
"totalItems": 0,
"totalPages": 0,
"currentPage": 0,
"pageSize": 0,
"items": [
{
"geographyId": 0,
"geographyName": "string",
"industryCode": "string",
"industryName": "string",
"categoryId": 0,
"categoryName": "string",
"companyId": 0,
"companyName": "string",
"brandId": 0,
"brandName": "string"
}
]
}
It is a paged result object with the following members:
| totalItems | The total number of records matching the request across all pages |
| totalPages | The total number of pages available for the request |
| currentPage | The page number returned in this response (starts at 1) |
| pageSize | The number of records returned per page |
| items | An array of Company objects for the requested page |
Each Brand object in the items array has the following members:
| geographyId | The geography ID associated with the brand record |
| geographyName | The name of the geography associated with the brand record |
| industryCode | The code for the industry this brand record is associated with |
| industryName | The name of the industry this brand record is associated with |
| categoryId | The category ID associated with the brand record |
| categoryName | The name of the category associated with the brand record |
| companyId | The unique identifier of the parent company that owns the brand |
| companyName | The name of the parent company that owns the brand |
| brandId | The unique identifier of the brand. Use a collection of these values when building requests to the main data services |
| brandName | The name of the brand |