Skip to main content
GET
List orders (paginated).

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Query Parameters

status
string

Filter by order status: draft, confirmed, fulfilled, cancelled, or refunded.

contact
string

Filter to orders belonging to a contact, by the contact's uuid.

per_page
integer

Items per page (alias: limit). Default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object