List orders
Food & Beverage
List Orders
List all F&B orders with optional filters
GET
List orders
List all orders for the workspace F&B module. Supports filtering by status, claim status, order type, table number, customer, and order number. Returns up to 200 orders sorted by creation date (newest first).
Request
Parameters
string
Filter by order status:
pending, preparing, ready, served, or cancelled.string
Filter by claim status:
not-claimed or claimed.string
Filter by order type:
dine-in or to-go.string
Filter by table number.
string
Filter by customer user ID, username, or display name (partial match).
string
Filter by order number.
Response
Status Codes
200: Orders returned successfully400: Invalid filter value401: API key is required or invalid403: F&B module is disabled or workspace access is denied
Authorizations
Pass your API key in the apikey header. Alternatively, the x-api-key header is also accepted.
Query Parameters
Filter by order status
Available options:
pending, preparing, ready, served, cancelled Filter by claim status
Available options:
not-claimed, claimed Filter by order type
Available options:
dine-in, to-go Filter by table number
Filter by customer user ID, username, or display name
Filter by order number
Response
Orders list

