Skip to main content
GET
Get a list of orders

Autorisierungen

Authorization
string
header
erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Abfrageparameter

include
string

Comma-separated. Allowed: customer, customer.business, customer.business.logo_image, customer.delivery_address, created_by, created_by.profile_image

page[number]
string
page[size]
string
filter[status]
string
filter[created_at_range]
string

Creation date range. Same shape as other *_range filters (from/to or presets such as today).

filter[created_by]
string

Creator IDs. Repeat with [] for multiple values.

filter[created_by_type]
enum<string>

Restrict creators to staff (users) or customers (customers).

Verfügbare Optionen:
users,
customers
sort
string
o
string

Organization ID

Antwort

200 - application/vnd.api+json

OK

data
Order · object

An order groups one or more bookings into a single transaction with payment and invoicing.