Skip to content

Get Brands

List brands, manage markets (geographic regions), and update aliases (alternate brand names).

Requires authentication
60 req/min

List Brands

GET/get-brands

Returns all brands that your API key has access to. This includes brands you own and brands you've been invited to as a team member.

Query Parameters

brand_idstring

Filter to a single brand by UUID

includestring

Comma-separated: "markets", "aliases"

Without the include parameter, brands are returned with basic fields only. Add include=markets,aliases to embed sub-resources in the response.
Rate limit: 60 requests/minute for GET. Write operations (POST, PUT, DELETE) are limited to 30 requests/minute.

Response Fields

Each brand in the response includes these fields:

Brand Object

idstring

Unique brand identifier (UUID)

namestring

Display name of the brand

websitestring

Brand website URL

activeboolean

Whether the brand is active

rolestring

Your role: "owner", "editor", or "viewer"

marketsarray

Markets (only when include=markets). Array of market objects.

aliasesarray

Brand aliases (only when include=aliases). Array of strings.

Using Brand IDs

The id field is a unique identifier that you'll use in other API calls. Use it as the brand_id parameter:

GET /get-scores?brand_id=75ffdeb9-0924-4ff9-8ded-c2470d73d224

Markets

Markets represent geographic regions where your brand is tracked. Each brand has one primary market and can have additional markets depending on your plan.

Market Object

idstring

Market UUID

brand_idstring

Parent brand UUID

locationstring

ISO-2 country code (e.g. "US", "GB", "DE")

is_primaryboolean

Whether this is the primary market

activeboolean

Whether the market is active

created_atstring

ISO 8601 creation timestamp

Add Market

POST/get-brands/markets

Body Parameters

brand_idstringrequired

Brand UUID

locationstringrequired

ISO-2 country code (e.g. "US", "GB", "DE")

market_namestring

Optional display name for the market

The first market added to a brand automatically becomes the primary market. Use standard ISO-2 country codes (US, GB, DE, FR, JP, etc.).

Remove Market

DELETE/get-brands/markets

Query Parameters

brand_idstringrequired

Brand UUID

market_idstringrequired

Market UUID to remove

You cannot remove the primary market. Change the primary market in your brand settings first.

Market Examples

Add Market
1curl -X POST 'https://api.trakkr.ai/get-brands/markets' \
2 -H 'Authorization: Bearer $TRAKKR_API_KEY' \
3 -H 'Content-Type: application/json' \
4 -d '{"brand_id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224", "location": "GB"}'
1{
2 "id": "m9a8b7c6-d5e4-3210-abcd-ef0987654321",
3 "brand_id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224",
4 "location": "GB",
5 "is_primary": false,
6 "active": true,
7 "created_at": "2026-03-07T10:00:00Z"
8}

Aliases

Aliases are alternate names for your brand that get aggregated into your visibility score. For example, "Nike" might also appear as "Nike Inc", "Nike.com", or "Nike Running" in AI responses.

PUT/get-brands/aliases

Body Parameters

brand_idstringrequired

Brand UUID

aliasesstring[]required

Array of alias strings

This replaces all existing aliases. To add an alias, include the existing aliases plus the new one. Duplicates are automatically removed.

Aliases Examples

Update Aliases
1curl -X PUT 'https://api.trakkr.ai/get-brands/aliases' \
2 -H 'Authorization: Bearer $TRAKKR_API_KEY' \
3 -H 'Content-Type: application/json' \
4 -d '{"brand_id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224", "aliases": ["Nike Inc", "Nike.com", "Nike Running"]}'
1{
2 "success": true,
3 "brand_id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224",
4 "aliases": ["Nike Inc", "Nike.com", "Nike Running"]
5}

Next Steps

After getting your brand IDs, you can:

Code Example

List Brands
1curl -H 'Authorization: Bearer $TRAKKR_API_KEY' \
2 'https://api.trakkr.ai/get-brands?include=markets,aliases'
1{
2 "brands": [
3 {
4 "id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224",
5 "name": "Nike",
6 "website": "https://nike.com",
7 "active": true,
8 "role": "owner",
9 "aliases": ["Nike Inc", "Nike.com", "Nike Running"],
10 "markets": [
11 {
12 "id": "m1a2b3c4-d5e6-7890-abcd-ef1234567890",
13 "brand_id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224",
14 "location": "US",
15 "is_primary": true,
16 "active": true,
17 "created_at": "2026-01-15T10:00:00Z"
18 },
19 {
20 "id": "m9a8b7c6-d5e4-3210-abcd-ef0987654321",
21 "brand_id": "75ffdeb9-0924-4ff9-8ded-c2470d73d224",
22 "location": "GB",
23 "is_primary": false,
24 "active": true,
25 "created_at": "2026-02-20T14:30:00Z"
26 }
27 ]
28 }
29 ]
30}
Press ? for keyboard shortcuts