Brands
List brands
Return all brands that belong to your organization.
GET
/
v1
/
brands
List brands
curl --request GET \
--url https://api.example.com/v1/brandsimport requests
url = "https://api.example.com/v1/brands"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/brands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/brands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/brands"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/brands")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"displayName": "<string>",
"targetMarket": {},
"language": "<string>"
}
],
"count": 123
}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"
import requests
r = requests.get(
"https://app.get-spotlight.com/api/v1/brands",
headers={"x-spotlight-api-key": "YOUR_API_KEY"},
)
brands = r.json()["data"]
const r = await fetch("https://app.get-spotlight.com/api/v1/brands", {
headers: { "x-spotlight-api-key": "YOUR_API_KEY" },
});
const { data } = await r.json();
Response
Array of brand objects.
Show Brand object
Show Brand object
Total number of brands returned.
{
"data": [
{
"id": "brand-uuid-123",
"name": "my-brand",
"displayName": "My Brand",
"targetMarket": "US SMB",
"language": "en"
}
],
"count": 1
}
⌘I
List brands
curl --request GET \
--url https://api.example.com/v1/brandsimport requests
url = "https://api.example.com/v1/brands"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/brands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/brands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/brands"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/brands")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"name": "<string>",
"displayName": "<string>",
"targetMarket": {},
"language": "<string>"
}
],
"count": 123
}