List channels
curl --request GET \
--url https://firespark.cloud/api/storefront/v1/channels \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/storefront/v1/channels"
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/storefront/v1/channels', 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/storefront/v1/channels",
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/storefront/v1/channels"
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/storefront/v1/channels")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/storefront/v1/channels")
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": "app",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Mobile app",
"type": "APP",
"status": "ACTIVE",
"cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"cms": {
"id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"name": "App landing page",
"entity": "CHANNELS",
"status": "ACTIVE",
"fields": [
{
"name": "hero_title",
"type": "TEXT",
"label": { "en_us": "Hero title" },
"required": true,
"value": "Order from our app"
}
]
}
},
{
"id": "web",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Web ordering",
"type": "WEB",
"status": "ACTIVE",
"cms_template_id": null,
"cms": null
}
]
}
Channels
List channels
List all customer-facing sales channels for the merchant.
GET
/
channels
List channels
curl --request GET \
--url https://firespark.cloud/api/storefront/v1/channels \
--header 'Authorization: Bearer <token>'import requests
url = "https://firespark.cloud/api/storefront/v1/channels"
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/storefront/v1/channels', 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/storefront/v1/channels",
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/storefront/v1/channels"
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/storefront/v1/channels")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firespark.cloud/api/storefront/v1/channels")
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": "app",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Mobile app",
"type": "APP",
"status": "ACTIVE",
"cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"cms": {
"id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"name": "App landing page",
"entity": "CHANNELS",
"status": "ACTIVE",
"fields": [
{
"name": "hero_title",
"type": "TEXT",
"label": { "en_us": "Hero title" },
"required": true,
"value": "Order from our app"
}
]
}
},
{
"id": "web",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Web ordering",
"type": "WEB",
"status": "ACTIVE",
"cms_template_id": null,
"cms": null
}
]
}
Returns every active channel configured for the merchant. Use this endpoint to build channel pickers or to load channel metadata before configuring menus and checkout flows.
Requires a Fire spark access token obtained through token
exchange. The token scopes requests to the
authenticated customer and merchant.
Request
curl "https://firespark.cloud/api/storefront/v1/channels" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response
The response wraps an array of channel objects indata. Only ACTIVE channels are included.
{
"data": [
{
"id": "app",
"uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Mobile app",
"type": "APP",
"status": "ACTIVE",
"cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"cms": {
"id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
"name": "App landing page",
"entity": "CHANNELS",
"status": "ACTIVE",
"fields": [
{
"name": "hero_title",
"type": "TEXT",
"label": { "en_us": "Hero title" },
"required": true,
"value": "Order from our app"
}
]
}
},
{
"id": "web",
"uid": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"organization_id": "11111111-1111-1111-1111-111111111111",
"merchant_id": "22222222-2222-2222-2222-222222222222",
"name": "Web ordering",
"type": "WEB",
"status": "ACTIVE",
"cms_template_id": null,
"cms": null
}
]
}
Channel object
| Field | Type | Description |
|---|---|---|
id | string | External channel identifier. Alphanumeric characters, _, and - only. 1–64 characters. |
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. |
type | string | Channel surface. One of APP, WEB, KIOSK, POS, CALL_CENTER, or AGGREGATOR. |
status | string | ACTIVE or INACTIVE. |
cms_template_id | string (UUID) | CMS template linked to this channel. 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 channel. |
cms
cms
Present only when
Each field in
cms_template_id is not null. Contains the resolved CMS template assigned to the channel.| Field | Required | Type | Description |
|---|---|---|---|
id | Yes | string (UUID) | Template identifier. Matches cms_template_id. |
name | Yes | string | Template name. 1–100 characters. |
entity | Yes | string | Always CHANNELS for channel responses. |
status | Yes | string | ACTIVE or INACTIVE. |
fields | Yes | array | Template fields with their current stored values. |
fields:| Field | Required | Type | Description |
|---|---|---|---|
name | Yes | string | Field key. |
type | Yes | string | TEXT, SELECT, IMAGE, or LIST. |
label | No | object | Optional localized label keyed by locale. |
required | No | boolean | Whether the field is required. |
placeholder | No | string | Optional placeholder text. |
options | No | array | For SELECT fields — objects with label and value. |
altText | No | string | For IMAGE fields — alternative text. |
src | No | string | For IMAGE fields — image URL. |
href | No | string | For IMAGE fields — optional link URL. |
value | No | varies | Current stored value for this channel. Omitted when empty. |
Error responses
| Status | Description |
|---|---|
401 | Missing or invalid access token. |
403 | Token does not have access to this merchant’s channels. |
⌘I