Skip to main content
GET
/
v1
/
brands
List brands
curl --request GET \
  --url https://api.example.com/v1/brands
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "displayName": "<string>",
      "targetMarket": {},
      "language": "<string>"
    }
  ],
  "count": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.get-spotlight.com/llms.txt

Use this file to discover all available pages before exploring further.

Brands are the top-level entities you track in Spotlight (e.g. your company or product lines). Call this endpoint first to discover available brandId values for use in other endpoints.

​
Request

curl -s \
  -H "x-spotlight-api-key: YOUR_API_KEY" \
  "https://app.get-spotlight.com/api/v1/brands"

​
Response

​
data
Brand[]
Array of brand objects.
​
count
integer
Total number of brands returned.
{
  "data": [
    {
      "id": "brand-uuid-123",
      "name": "my-brand",
      "displayName": "My Brand",
      "targetMarket": "US SMB",
      "language": "en"
    }
  ],
  "count": 1
}