Skip to main content
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 successfully
  • 400: Invalid filter value
  • 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

status
enum<string>

Filter by order status

Available options:
pending,
preparing,
ready,
served,
cancelled
claimStatus
enum<string>

Filter by claim status

Available options:
not-claimed,
claimed
orderType
enum<string>

Filter by order type

Available options:
dine-in,
to-go
tableNumber
string

Filter by table number

customer
string

Filter by customer user ID, username, or display name

orderNumber
string

Filter by order number

Response

Orders list