Get a brand

Get a brand by the given brand id.

get

Path parameters

idstringRequired

The id of the brand.

Query parameters

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

404

The Brand was not found in the system.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/brands/{id} HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "parentId": "sApKpllz4sAplsmzha",
    "code": "EXA",
    "name": "Example",
    "abbr": "EXA",
    "description": "JFW",
    "status": "Inactive",
    "isSystem": false,
    "tags": "Example, JFW",
    "profile": {
      "logoUrl": "https://www.example.com/logo.png",
      "faviconUrl": "https://www.example.com/favicon.ico",
      "slogan": "Example Slogan",
      "primaryColor": "#000000",
      "primaryColorHover": "#000000",
      "secondaryColor": "#000000",
      "tertiaryColor": "#000000"
    },
    "setting": {
      "domainWhiteListUrls": "https://whitelist.example.io",
      "googleAnalyticsAccount": "UA-******-1",
      "reCaptchaKey": "6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy",
      "coinCurrencyCode": "EXA",
      "cdnUrl": "https://cdn.example.com",
      "cdnFolder": "exam_cdn",
      "passwordPolicyLevel": "Low"
    },
    "domains": [],
    "id": "sApKpllz4sAplsmzha"
  },
  "errors": []
}