Skip to main content
GET
List orders - v3

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id
string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Query Parameters

page[number]
integer
default:1

Page number, starting at 1. Defaults to 1 when omitted.

Required range: x >= 1
Example:

1

page[size]
integer
default:100

Page size. Must be between 1 and 300. Defaults to 100 when omitted.

Required range: 1 <= x <= 300
Example:

100

sort
enum<string>
default:-createdAt

Sort order. -createdAt (default) returns newest first; createdAt returns oldest first.

Available options:
createdAt,
-createdAt
Example:

"-createdAt"

filter[status]
enum<string>

Filter by order status.

Available options:
active,
cancelled
Example:

"active"

filter[idempotencyKey]
string[]

Comma-separated list of idempotency keys. Returns orders matching any of the supplied keys.

Minimum array length: 1
Minimum string length: 1
Example:
filter[createdAt]
object

Filter by order creation timestamp. Accepts full ISO timestamps via filter[createdAt][gte] and filter[createdAt][lte].

Response

Page of orders plus pagination links.

JSON:API list envelope. Returns the page of orders plus pagination links.

data
object[]
required

Orders matching the query, ordered per sort.

Top-level JSON:API-style pagination links for paginated list responses. first, next, and prev are all required and all nullable. prev is null on cursor-paginated endpoints (backward navigation not supported).

Last modified on June 17, 2026