Get Brands
List brands, manage markets (geographic regions), and update aliases (alternate brand names).
List 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_idstringFilter to a single brand by UUID
includestringComma-separated: "markets", "aliases"
include parameter, brands are returned with basic fields only. Add include=markets,aliases to embed sub-resources in the response.Response Fields
Each brand in the response includes these fields:
Brand Object
idstringUnique brand identifier (UUID)
namestringDisplay name of the brand
websitestringBrand website URL
activebooleanWhether the brand is active
rolestringYour role: "owner", "editor", or "viewer"
marketsarrayMarkets (only when include=markets). Array of market objects.
aliasesarrayBrand 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:
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
idstringMarket UUID
brand_idstringParent brand UUID
locationstringISO-2 country code (e.g. "US", "GB", "DE")
is_primarybooleanWhether this is the primary market
activebooleanWhether the market is active
created_atstringISO 8601 creation timestamp
Add Market
Body Parameters
brand_idstringrequiredBrand UUID
locationstringrequiredISO-2 country code (e.g. "US", "GB", "DE")
market_namestringOptional display name for the market
Remove Market
Query Parameters
brand_idstringrequiredBrand UUID
market_idstringrequiredMarket UUID to remove
Market Examples
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.
Body Parameters
brand_idstringrequiredBrand UUID
aliasesstring[]requiredArray of alias strings
Aliases Examples
Next Steps
After getting your brand IDs, you can:
- Get visibility scores - See your brand's AI visibility metrics
- Competitor analysis - Compare against competitors
- Get citations - See which URLs are cited
- Crawler analytics - See which AI crawlers visit your site
