List brands - Fire spark

{
  "data": [
    {
      "id": "0001",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "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",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Taco Co.",
      "status": "ACTIVE",
      "cms_template_id": null,
      "cms": null
    }
  ]
}

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.

Requires an access token with the brands:read scope. See Token to obtain a token.

Request

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.

{
  "data": [
    {
      "id": "0001",
      "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "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",
      "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
      "name": "Taco Co.",
      "status": "ACTIVE",
      "cms_template_id": null,
      "cms": null
    }
  ]
}

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.
`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`