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

# List brands

> Read brand configuration for POS and RMS mapping.

Returns all active brands configured for the authenticated merchant. Use this endpoint to map Fire spark brands to concepts in your POS or RMS before filtering stores and menus with `brand_id`.

<Note>
  Requires an access token with the `brands:read` scope. See
  [Token](/docs/integrations-api/oauth/token/post) to obtain a token.
</Note>

## Request

```bash theme={null}
curl "https://firespark.cloud/api/integrations/v1/brands" \
  -H "Authorization: Bearer ACCESS_TOKEN"
```

## Response

The response wraps an array of brand objects in `data`. Only `ACTIVE` brands are included.

<ResponseExample>
  ```json Success theme={null}
  {
    "data": [
      {
        "id": "0001",
        "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
        "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
        "name": "Burger Co.",
        "status": "ACTIVE",
        "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
        "cms": {
          "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
          "name": "Brand landing page",
          "entity": "BRANDS",
          "status": "ACTIVE",
          "fields": [
            {
              "name": "tagline",
              "type": "TEXT",
              "label": { "en_us": "Tagline" },
              "required": false,
              "value": "Flame-grilled since 1987"
            }
          ]
        }
      },
      {
        "id": "0002",
        "uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "organization_id": "f1e2d3c4-b5a6-7890-fedc-ba0987654321",
        "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
        "name": "Taco Co.",
        "status": "ACTIVE",
        "cms_template_id": null,
        "cms": null
      }
    ]
  }
  ```
</ResponseExample>

## Brand object

| Field             | Type          | Description                                                                                                                                           |
| ----------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`              | string        | External brand identifier. Alphanumeric characters, `_`, and `-` only. 1–64 characters. Use this value in `brand_id` when filtering stores and menus. |
| `uid`             | string (UUID) | Fire spark internal identifier.                                                                                                                       |
| `organization_id` | string (UUID) | Fire spark organization identifier.                                                                                                                   |
| `merchant_id`     | string (UUID) | Fire spark merchant identifier.                                                                                                                       |
| `name`            | string        | Display name. 1–100 characters.                                                                                                                       |
| `status`          | string        | `ACTIVE` or `INACTIVE`.                                                                                                                               |
| `cms_template_id` | string (UUID) | CMS template linked to this brand. `null` when no template is assigned.                                                                               |
| `cms`             | object        | Read-only. `null` when `cms_template_id` is `null`. When set, the resolved CMS template for this brand.                                               |

## Error responses

| Status | Description                          |
| ------ | ------------------------------------ |
| `401`  | Missing or invalid access token      |
| `403`  | Token does not include `brands:read` |


## OpenAPI

````yaml integrations-api/openapi.json GET /brands
openapi: 3.0.1
info:
  title: Fire spark Integrations API
  description: POS and RMS integration endpoints for Fire spark.
  version: 1.0.0
servers:
  - url: https://firespark.cloud/api/integrations/v1
security:
  - bearerAuth: []
paths:
  /brands:
    get:
      summary: List brands
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BrandRead'
components:
  schemas:
    BrandRead:
      type: object
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 64
          pattern: ^[a-zA-Z0-9_-]+$
        uid:
          type: string
          format: uuid
        organization_id:
          type: string
          format: uuid
        merchant_id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
        cms_template_id:
          type: string
          format: uuid
          nullable: true
        cms:
          type: object
          nullable: true
          additionalProperties: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````