All index endpoints support pagination thanks to three parameters limit, starting_after and ending_before.
Both starting_after and ending_before parameters take an ID and return corresponding objects in descending ID order. The starting_after parameter returns objects with ID greater than the specified value. The ending_before parameter returns objects with ID lower than the specified value.
| Request Parameter | Description |
|---|---|
| limit integer, optional | A limit on the number of objects to be returned, between 1 and 100 - default is 10 |
| starting_after ID, optional | object ID that defines your place in the list |
| ending_before ID, optional | object ID that defines your place in the list |
| Response Format | Description |
|---|---|
| object string | value is "list" |
| has_more boolean | Whether or not there are more elements available after this set. If false, this set includes the end of the list. |
| data array | An array containing the actual requested resources, paginated by any request parameters |
curl https://api.shipup.co/v2/trackers \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer ${PRIVATE_KEY}" \
-d "limit"=25 \
-d "starting_after"=900
{
"object": "list",
"has_more": false,
"data": [
{
"object": "tracker",
"id": 903,
// ...
},
{
"object": "tracker",
"id": 902,
// ...
},
{
"object": "tracker",
"id": 901,
// ...
}
]
}