List brands
curl --request GET \
--url https://firespark.cloud/api/integrations/v1/brands \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/integrations/v1/brands"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://firespark.cloud/api/integrations/v1/brands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://firespark.cloud/api/integrations/v1/brands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://firespark.cloud/api/integrations/v1/brands"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://firespark.cloud/api/integrations/v1/brands")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/integrations/v1/brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
]
}
Brands
List brands
Read brand configuration for POS and RMS mapping.
GET
/
brands
List brands
curl --request GET \
--url https://firespark.cloud/api/integrations/v1/brands \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/integrations/v1/brands"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://firespark.cloud/api/integrations/v1/brands', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://firespark.cloud/api/integrations/v1/brands",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://firespark.cloud/api/integrations/v1/brands"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://firespark.cloud/api/integrations/v1/brands")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/integrations/v1/brands")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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
}
]
}
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 indata. Only ACTIVE brands are included.
{
"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
}
]
}
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 |
⌘I