Skip to main content

Pagination

All endpoints fetching multiple items are paginated. Use skip to skip to the items you want to retrieve. Use take to define how many items you want to retrieve. skip and take are optional parameters. If you do not input them, skip equals to 0 and take equals to 10.

Example

This request will skip the first 20 shipments and return the next 10. GET /v1/shipments hides cancelled shipments by default. Pass include_cancelled=true to include them in the list.

Response Format

Most paginated endpoints return an array. GET /v1/quote-requests returns an object with an items array and a total counting every match before pagination.

Pagination Parameters

Limits

The maximum value for take is 100. For GET /v1/quote-requests, a value above 100 returns HTTP 400.