Zeal's API endpoints use cursor-based pagination through the start_at
parameter. start_at
accepts an existing object ID value and returns a limited set of objects in chronological order. The start_at
parameter returns objects listed at and after the named object.
Not all Zeal API endpoints allow pagination. You can see whether an endpoint employs pagination or not by visiting the endpoint's documentation.
Example:
curl --request GET \
--url https://api.zeal.com/company/2d37ce1146d275fa36b108c54a7c02e8/contractorPayments?start_at=d210f054bf5b006f50aecbd7&limit=10 \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{testApiKey}}'
{
"data": [...],
"success": true,
"testMode": true,
"meta": {
"next": "https://api.zeal.com/company/2d37ce1146d275fa36b108c54a7c02e8/contractorPayments?start_at=d210f054bf5b006f50aecbe1&limit=10",
"previous": null
}
}