API Reference

List orders

get
https://api-sandbox.cargoboard.com/v1/orders

Returns your orders as a paginated list. Supports paging, sorting and filtering. The links array contains next / previous page links — see Filtering and Searching.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required
0 to 50

Number of results per page (max. 50). Required.

number

Cursor for the next page — take the value from the previous response.

orderBy
array of strings
Defaults to sequence

Sort order: sequence (ascending, default) or -sequence (descending). Other values return 422.

orderBy
filter
array of strings

Filter expression <field><operator><value>, e.g. product=STANDARD or createdAt>=2026-01-01. Operators: =, !=, <, <=, >, >=, ~ (contains). Use | for OR on one field, e.g. status=INITIALIZED|CREATED. See Filtering and Searching. Allowed fields: see Filtering and Searching.

filter
string
Defaults to AND

How multiple filters are combined: AND (default) or OR.

boolean
Defaults to false

Set to true to include the total number of results.

Responses

403

Missing or invalid X-API-KEY, or no access to this resource.

422

Validation failed — the message array lists the missing or invalid fields.

Updated 6 days ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago