Skip to main content
GET
/
brand
/
retrieve-simplified
JavaScript
import BrandDev from 'brand.dev';

const client = new BrandDev({
  apiKey: 'My API Key',
});

const response = await client.brand.retrieveSimplified({ domain: 'domain' });

console.log(response.brand);
{
  "status": "<string>",
  "brand": {
    "domain": "<string>",
    "title": "<string>",
    "colors": [
      {
        "hex": "<string>",
        "name": "<string>"
      }
    ],
    "logos": [
      {
        "url": "<string>",
        "mode": "light",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        },
        "type": "icon"
      }
    ],
    "backdrops": [
      {
        "url": "<string>",
        "colors": [
          {
            "hex": "<string>",
            "name": "<string>"
          }
        ],
        "resolution": {
          "width": 123,
          "height": 123,
          "aspect_ratio": 123
        }
      }
    ]
  },
  "code": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
domain
string
required

Domain name to retrieve simplified brand data for

​
timeoutMS
integer

Optional timeout in milliseconds for the request. If the request takes longer than this value, it will be aborted with a 408 status code. Maximum allowed value is 300000ms (5 minutes).

Required range: 1 <= x <= 300000

Response

Successful response

​
status
string

Status of the response, e.g., 'ok'

​
brand
object

Simplified brand information

​
code
integer

HTTP status code of the response

⌘I