Teams API
List orders
Fetches a list of orders for the team associated with the API key. Orders can be filtered by order number, email, and date range. Results are paginated.
GET
List orders
Authorizations
The API key required for accessing protected routes. It should be included in the request headers as x-api-key
.
Query Parameters
Filter orders by order number.
Required range:
x >= 1
Filter orders by customer email.
Filter orders created after this date.
Filter orders created before this date.
The maximum number of items to return (1-1000).
Required range:
1 <= x <= 1000
The number of items to skip before starting to collect the result set.
Required range:
x >= 0
The sort order of the results.
Available options:
asc
, desc
The field by which to order the results.
If true, returns additional pagination metadata including total count and total pages.
Response
200
application/json
Successfully retrieved team orders.
The response is of type object
.
List orders