> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: List Brands

> List the brands in an Intercom workspace, including the default brand. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the brands in an Intercom workspace, including the default brand.

> [!NOTE]
>
> Tool ID: `intercom_list_brands`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_brands',
  {},
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_list_brands --input '{}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "example",
    "data": [
      {
        "type": "example",
        "id": "id_123",
        "name": "Example"
      }
    ]
  }
}
```

Use `deepline describe intercom_list_brands --json` for the latest machine-readable contract.

## Input reference

Retrieves all brands for the workspace, including the default brand. The default brand id always matches the workspace

This action requires no input fields.

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves all brands for the workspace, including the default brand. The default brand id always matches the workspace",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A list of brands |
| `result.data.type` | `string` | No | — | The type of object |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].type` | `string` | No | — | The type of object |
| `result.data.data[].id` | `string` | No | — | Unique brand identifier. For default brand, matches the workspace ID |
| `result.data.data[].name` | `string` | No | — | Display name of the brand |
| `result.data.data[].is_default` | `boolean` | No | — | Whether this is the workspace's default brand |
| `result.data.data[].created_at` | `integer` | No | — | Unix timestamp of brand creation Format: `date-time`. |
| `result.data.data[].updated_at` | `integer` | No | — | Unix timestamp of last modification Format: `date-time`. |
| `result.data.data[].help_center_id` | `string` | No | — | Associated help center identifier |
| `result.data.data[].default_address_settings_id` | `string` | No | — | Default email settings ID for this brand |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "A list of brands",
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of object"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "description": "Represents a branding configuration for the workspace",
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of object"
                },
                "id": {
                  "type": "string",
                  "description": "Unique brand identifier. For default brand, matches the workspace ID"
                },
                "name": {
                  "type": "string",
                  "description": "Display name of the brand"
                },
                "is_default": {
                  "type": "boolean",
                  "description": "Whether this is the workspace's default brand"
                },
                "created_at": {
                  "type": "integer",
                  "description": "Unix timestamp of brand creation",
                  "format": "date-time"
                },
                "updated_at": {
                  "type": "integer",
                  "description": "Unix timestamp of last modification",
                  "format": "date-time"
                },
                "help_center_id": {
                  "type": "string",
                  "description": "Associated help center identifier"
                },
                "default_address_settings_id": {
                  "type": "string",
                  "description": "Default email settings ID for this brand"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.