Brands

Endpoints

GET/v1/brands/{brand}
GET/v1/brands

The Brand object

Attributes

idstring
Unique identifier of the object (prefixed, opaque).
objectstring
brand
namestring
slugstring
verticalstring
What the brand sells: products, software / online services, or a physical establishment.
site_urlstringnullable
logo_urlstring
Signed URL, valid 60 minutes.
platformstringnullable
livemodeboolean
true for live data, false for the test-mode sandbox.
createdinteger
Time at which the object was created (unix timestamp, seconds).

The Brand object


{
  "id": "br_034CyfRFSXUqzrbzV6MAfZ",
  "object": "brand",
  "name": "Nordvelo",
  "slug": "nordvelo",
  "vertical": "string",
  "site_url": "https://nordvelo.fr",
  "logo_url": "string",
  "platform": "shopify",
  "livemode": true,
  "created": 1790000000
}

Retrieve a brand

GET/v1/brands/{brand}

Parameters

brandstringrequired
Brand id (br_…).

Returns

Returns the brand object. Raises an error if something goes wrong.

curl


curl https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
  },
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('GET', 'brands/br_034CyfRFSXUqzrbzV6MAfZ', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.get(
    "https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Response


{
  "id": "br_034CyfRFSXUqzrbzV6MAfZ",
  "object": "brand",
  "name": "Nordvelo",
  "slug": "nordvelo",
  "vertical": "string",
  "site_url": "https://nordvelo.fr",
  "logo_url": "string",
  "platform": "shopify",
  "livemode": true,
  "created": 1790000000
}

List brands

GET/v1/brands

The brands of the workspace this key can reach — all of them, or the selection made when the key was created. Test keys see the sandbox brands.