# Brands

## List all brands

**get** `/v2/brands`

Returns all brands in your organization with cursor-based pagination.

### Query Parameters

- `limit` - Number of brands to return (1-100, default: 10)
- `cursor` - Opaque cursor from a previous response for pagination

### Response Structure

The response includes:

- `object` - Always "list"
- `data` - Array of brand objects
- `nextCursor` - Cursor for the next page (null if no more results)

### Brand Object

Each brand includes:

- `id` - Featurebase internal ID (MongoDB ObjectId)
- `name` - Brand display name
- `isDefault` - Whether this is the default brand
- `createdAt` - Creation timestamp
- `updatedAt` - Last update timestamp
- `helpCenterId` - Associated help center ID
- `senderEmailAddressId` - Default sender email address ID

### Example Response

```json
{
  "object": "list",
  "data": [
    {
      "object": "brand",
      "id": "507f1f77bcf86cd799439011",
      "name": "Default Brand",
      "isDefault": true,
      "createdAt": "2025-01-01T12:00:00.000Z",
      "updatedAt": "2025-01-10T15:30:00.000Z",
      "helpCenterId": "11",
      "senderEmailAddressId": "507f1f77bcf86cd799439012"
    }
  ],
  "nextCursor": null
}
```

### Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

### Query Parameters

- `cursor: optional string`

  An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

- `limit: optional number`

  A limit on the number of brands to be returned, between 1 and 100.

### Header Parameters

- `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"`

  - `"2026-01-01.nova"`

  - `"2025-12-12.clover"`

### Returns

- `data: array of Brand`

  Array of brands

  - `id: string`

    Featurebase internal ID

  - `createdAt: string`

    ISO date when brand was created

  - `helpCenterId: string`

    The ID of the help center associated with this brand

  - `isDefault: boolean`

    Whether this is the default brand

  - `name: string`

    Brand display name

  - `object: "brand"`

    Object type identifier

    - `"brand"`

  - `senderEmailAddressId: string`

    The ID of the default sending email address for this brand

  - `updatedAt: string`

    ISO date when brand was last updated

- `nextCursor: string`

  Cursor for fetching the next page (cursor-based pagination)

- `object: "list"`

  Object type identifier

  - `"list"`

### Example

```http
curl https://do.featurebase.app/v2/brands \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY"
```

#### Response

```json
{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "createdAt": "2025-01-01T12:00:00.000Z",
      "helpCenterId": "11",
      "isDefault": true,
      "name": "Default Brand",
      "object": "brand",
      "senderEmailAddressId": "507f1f77bcf86cd799439012",
      "updatedAt": "2025-01-10T15:30:00.000Z"
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9",
  "object": "list"
}
```

## Get brand by ID

**get** `/v2/brands/{id}`

Retrieves a single brand by its Featurebase ID.

### Path Parameters

- `id` - The Featurebase internal ID of the brand (MongoDB ObjectId)

### Response

Returns a brand object with:

- `id` - Featurebase internal ID
- `name` - Brand display name
- `isDefault` - Whether this is the default brand
- `createdAt` - Creation timestamp
- `updatedAt` - Last update timestamp
- `helpCenterId` - Associated help center ID
- `senderEmailAddressId` - Default sender email address ID

### Example Response

```json
{
  "object": "brand",
  "id": "507f1f77bcf86cd799439011",
  "name": "Default Brand",
  "isDefault": true,
  "createdAt": "2025-01-01T12:00:00.000Z",
  "updatedAt": "2025-01-10T15:30:00.000Z",
  "helpCenterId": "11",
  "senderEmailAddressId": "507f1f77bcf86cd799439012"
}
```

### Error Responses

- **404 Not Found** - Brand with the specified ID does not exist

### Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

### Path Parameters

- `id: string`

  The Featurebase internal ID of the brand (MongoDB ObjectId)

### Header Parameters

- `"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"`

  - `"2026-01-01.nova"`

  - `"2025-12-12.clover"`

### Returns

- `Brand object { id, createdAt, helpCenterId, 5 more }`

  - `id: string`

    Featurebase internal ID

  - `createdAt: string`

    ISO date when brand was created

  - `helpCenterId: string`

    The ID of the help center associated with this brand

  - `isDefault: boolean`

    Whether this is the default brand

  - `name: string`

    Brand display name

  - `object: "brand"`

    Object type identifier

    - `"brand"`

  - `senderEmailAddressId: string`

    The ID of the default sending email address for this brand

  - `updatedAt: string`

    ISO date when brand was last updated

### Example

```http
curl https://do.featurebase.app/v2/brands/$ID \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY"
```

#### Response

```json
{
  "id": "507f1f77bcf86cd799439011",
  "createdAt": "2025-01-01T12:00:00.000Z",
  "helpCenterId": "11",
  "isDefault": true,
  "name": "Default Brand",
  "object": "brand",
  "senderEmailAddressId": "507f1f77bcf86cd799439012",
  "updatedAt": "2025-01-10T15:30:00.000Z"
}
```

## Domain Types

### Brand

- `Brand object { id, createdAt, helpCenterId, 5 more }`

  - `id: string`

    Featurebase internal ID

  - `createdAt: string`

    ISO date when brand was created

  - `helpCenterId: string`

    The ID of the help center associated with this brand

  - `isDefault: boolean`

    Whether this is the default brand

  - `name: string`

    Brand display name

  - `object: "brand"`

    Object type identifier

    - `"brand"`

  - `senderEmailAddressId: string`

    The ID of the default sending email address for this brand

  - `updatedAt: string`

    ISO date when brand was last updated