Brands List monitored brands and their configuration
A Brand is a workspace that tracks one brand across a primary domain and additional domains. The API returns brands on a paid plan only. Free brands do not appear.
Returns paid brands in the API key's scope. Ordered by creation date, newest first.
Keys with all brands access return every paid brand on the team
Scoped keys return only their authorised paid brands
Header Value Required AuthorizationBearer hdg_sk_live_...Yes
Parameter Type Description limitinteger Maximum results per page. Default: 100, max: 1000. offsetinteger Rows to skip. Default: 0.
curl https://api.useheading.com/v1/brands \ -H "Authorization: Bearer hdg_sk_live_abc123..." { "data" : [ { "id" : "f1e2d3c4-b5a6-7890-abcd-ef1234567890" , "name" : "Acme Corp" , "domain" : "acme.com" , "description" : "Enterprise workflow automation platform" , "location" : "en-US" , "targetMarkets" : [ { "market" : "en-US" , "areas" : [] }, { "market" : "de-DE" , "areas" : [ "Berlin" , "Munich" ] } ], "enabledModels" : [ "chatgpt" , "google_ai_overview" , "perplexity" ], "activePromptCount" : 30 , "createdAt" : "2026-03-15T00:00:00.000Z" , "updatedAt" : "2026-07-01T00:00:00.000Z" } ], "total" : 1 } Field Type Description idstring Brand UUID namestring Display name domainstring Primary domain descriptionstring or null Brand description locationstring or null The brand's primary market, as an IETF tag (en-US, de-DE) targetMarketsobject[] Markets the business declares it sells in. Each is { market, areas }, where areas is free text inside that market enabledModelsstring[] AI platforms tracked for this brand activePromptCountnumber Count of active monitoring prompts createdAtstring ISO 8601 creation timestamp updatedAtstring ISO 8601 last-update timestamp
Status Code When 400INVALID_PARAMInvalid query parameter 401MISSING_AUTHNo Authorization header 401INVALID_AUTHHeader is not Bearer {key} 401INVALID_KEYInvalid or revoked API key 429RATE_LIMIT_EXCEEDEDRate limit exceeded (100 req/min) 500INTERNAL_ERRORServer error