v2
latestOpenAPI 3.1.02026-08-07750280.6 KBList orders
Retrieve a paginated list of orders for your organization.
Supports filtering by order status:
- `pending` - Awaiting approval
- `confirmed` - Approved and in progress
- `completed` - Fulfilled
- `cancelled` - Cancelled by customer
- `refused` - Refused by organization
The `created_after` parameter (ISO-8601 datetime) enables incremental polling:
pass the `created_at` of the last order you received to get only newer ones.
Orders are returned in reverse chronological order (newest first) by default.
**Response shape note:** `data` is an object `{items, total, limit, offset}` for
backward compatibility. The top-level `meta` object `{limit, offset, total_items}`
is the standard pagination envelope and is always present.
Authentication:
- API key with READ or READ_WRITE permission
Query parameters
Filter by order status
Filter by order status
Number of items to return
Number of items to return
Number of items to skip
Number of items to skip
Sort field. Prefix with '-' for descending order. Available: created_at, status, total_amount. A deterministic id tiebreaker is always appended. Example: '-created_at' (newest first, default), 'total_amount' (cheapest first).
Sort field. Prefix with '-' for descending order. Available: created_at, status, total_amount. A deterministic id tiebreaker is always appended. Example: '-created_at' (newest first, default), 'total_amount' (cheapest first).
Return only orders created strictly after this ISO-8601 datetime (exclusive). Useful for incremental polling: pass the created_at of the last received order. Example: '2024-01-30T10:00:00Z'.
Return only orders created strictly after this ISO-8601 datetime (exclusive). Useful for incremental polling: pass the created_at of the last received order. Example: '2024-01-30T10:00:00Z'.
Response
Successfully retrieved orders list