Skip to main content
GET
Get category
Returns a single category from the active menu, including how it appears across channels, stores, and fulfillment types. Use this endpoint to render category headers, descriptions, and availability badges in your ordering UI.
Requires a Fire spark access token obtained through token exchange.

Path parameters

Query parameters

Request

Response

Category object

Map of channel codes. Each entry contains:Each store entry:Each fulfillment entry:Each entry in items:
Each schedule entry contains day_of_week (monday through sunday) and a periods array. Each period has optional closed (default false), start_time, end_time, and optional start_date / end_date bounds.

Error responses

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

External category identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

Query Parameters

fulfillment_id
string
required

External fulfillment identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
store_id
string
required

External store identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
channel_id
string
required

External channel identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$
brand_id
string
required

External brand identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

Response

200 - application/json

Ok

data
object