Skip to main content
GET
List channels
Returns all channels configured for the authenticated merchant. Use this endpoint to map Fire spark channels to ordering surfaces in your POS or RMS before syncing menus and routing orders.
Requires an access token with the channels:read scope. See Token to obtain a token.

Request

Response

The response wraps an array of channel objects in data. Each channel represents a sales surface — owned channels such as app or web, or aggregators such as Uber Eats.

Channel object

Present only when cms_template_id is not null. Contains the resolved CMS template assigned to the channel.Each field in fields:

Mapping channels to your POS

Match the id field to the channel identifier in your POS or RMS. Fire spark uses this external ID when composing menus and routing orders per surface.
Channel uid values are stable Fire spark identifiers. Use id for cross-system mapping and uid when referencing channels in other Fire spark API calls.

Error responses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Ok

data
object[]