Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Use your account's Secret Key as the Bearer token.

Query Parameters

page
integer
default:1

Page number for pagination.

Required range: x >= 1
per_page
integer
default:15

Number of results per page.

Required range: 1 <= x <= 100

Field to search by (e.g. email, tag).

query
string

Search term to filter by.

date_begin
string<date>

Start date filter (ISO 8601).

Example:

"2024-01-01"

date_end
string<date>

End date filter (ISO 8601).

Example:

"2024-12-31"

order
string
default:created_at

Field to sort results by.

sort
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
status
enum<string>

Filter by order status.

Available options:
DRAFT,
PENDING_DETAILS,
PENDING_PUBLISH,
PUBLISHED,
ACCEPTED,
REJECTED,
CANCELLED,
RELEASED
sandbox
boolean

Filter sandbox orders.

Response

200 - application/json

Paginated list of orders

current_page
integer
Example:

1

last_page
integer
Example:

5

per_page
integer
Example:

15

total
integer
Example:

73

from
integer
Example:

1

to
integer
Example:

15

data
object[]