Intercom API (unofficial showcase)
GET/brands/{id}

Retrieve a brand

Retrieves a brand by its unique identifier. Use this operation to inspect a specific brand's configuration, including whether it is the workspace's default brand. The response includes the brand's associated help center and default email settings identifiers.

2 parameters
idstringrequired
The unique identifier of the brand to retrieve.
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

3 status codes
200Returns the brand object, including its identifier, name, default status, timestamps, and associated help center and address settings identifiers.
typestringoptional
The type of object
idstringoptional
Unique brand identifier. For default brand, matches the workspace ID
namestringoptional
Display name of the brand
is_defaultbooleanoptional
Whether this is the workspace's default brand
created_atintegeroptional
Unix timestamp of brand creation
updated_atintegeroptional
Unix timestamp of last modification
help_center_idstringoptional
Associated help center identifier
default_address_settings_idstringoptional
Default email settings ID for this brand
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
404Returned when the brand is not found.

One documented failure

  • not_found

    Brand not found

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, and a 404 is returned when the brand is not found. The id path parameter must identify an existing brand.