Skip to main content
GET
List menu items
List every menu item for the workspace F&B module. Each item includes its parent category as an embedded field. Optionally filter by category or availability. Items can be organized in a parent/sub-item hierarchy. A parent item (e.g. “Flavored Black Tea”) can have sub-items (e.g. “Honey Black Tea”, “Lychee Black Tea”). Sub-items have a ParentItemId referencing their parent, and parent items include a SubItems array in the response.

Request

Parameters

string
Filter by menu category ID.
string
Filter by availability: true for available items only, false for unavailable items only.

Response

Fields

Status Codes

  • 200: Menu items returned successfully
  • 401: API key is required or invalid
  • 403: F&B module is disabled or workspace access is denied

Authorizations

apikey
string
header
required

Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.

Query Parameters

categoryId
string

Filter by menu category ID

available
enum<string>

Filter by availability

Available options:
true,
false

Response

Menu items list. Each item includes Id, Name, CategoryId, Description, Price, Available, GamepassId, ParentItemId (if sub-item), Category (embedded), and SubItems (array of child items, if any).