Skip to main content
GET
/
brands
/
{brand_id}
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const brand = await client.brands.retrieve('brand_id');

console.log(brand.id);
{
  "id": "VWNG5GW9DE80VKKVQNFN1ENXEYG3",
  "name": "Default Brand",
  "published": 1,
  "created": 1,
  "updated": 1,
  "settings": {
    "colors": {
      "primary": "string",
      "secondary": "string"
    },
    "email": {
      "templateOverride": {
        "backgroundColor": "string",
        "blocksBackgroundColor": "string",
        "enabled": true,
        "footer": "string",
        "head": "string",
        "header": "string",
        "width": "string",
        "mjml": {
          "backgroundColor": "string",
          "blocksBackgroundColor": "string",
          "enabled": true,
          "footer": "string",
          "head": "string",
          "header": "string",
          "width": "string"
        },
        "footerBackgroundColor": "string",
        "footerFullWidth": true
      },
      "head": {
        "inheritDefault": true,
        "content": "string"
      },
      "footer": {
        "content": "string",
        "inheritDefault": true
      },
      "header": {
        "inheritDefault": true,
        "barColor": "string",
        "logo": {
          "href": "https://example.com",
          "image": "string"
        }
      }
    },
    "inapp": {
      "borderRadius": "string",
      "disableMessageIcon": true,
      "fontFamily": "string",
      "placement": "top",
      "widgetBackground": {
        "topColor": "string",
        "bottomColor": "string"
      },
      "colors": {
        "primary": "string",
        "secondary": "string"
      },
      "icons": {
        "bell": "string",
        "message": "Example message text"
      }
    }
  },
  "snippets": {
    "items": [
      {
        "name": "Default Brand",
        "value": "string"
      }
    ]
  },
  "version": "string"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

brand_id
string
required

A unique identifier associated with the brand you wish to retrieve.

Response

200 - application/json
id
string
required
name
string
required
created
integer<int64>
required
updated
integer<int64>
required
published
integer<int64> | null
settings
BrandSettings · object | null
snippets
BrandSnippets · object | null
version
string | null