List all brands | Intercom API (unofficial showcase)

1 parameter

Intercom-Versionstringoptional

The Intercom API version to use. Defaults to 2.17 when omitted.

Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes

200Returns a list of brand objects, including each brand's identifier, name, default status, timestamps, and associated help center and address settings.

typestringoptional

The type of object

dataarray<Brand>optional

401Returned when the request is unauthorized.

typestringrequired

The type is error.list

request_idstringoptional

errorsarray<object>required

An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized; authenticate the request with a valid Authorization header.

import { Client } from "@octridev/intercom";

const client = new Client({
  baseUrl: "https://api.intercom.io",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.brands.list();

{
  "type": "list",
  "data": [
    {
      "type": "brand",
      "id": "tlkp1d91",
      "name": "Default Brand",
      "is_default": true,
      "created_at": 1673778600,
      "updated_at": 1711031100,
      "help_center_id": "11",
      "default_address_settings_id": "13"
    },
    {
      "type": "brand",
      "id": "3",
      "name": "Premium Brand",
      "is_default": false,
      "created_at": 1686387300,
      "updated_at": 1709229600,
      "help_center_id": "10",
      "default_address_settings_id": "15"
    }
  ]
}

Request

Response

Errors