Pagination

Zeal's API endpoints use cursor-based pagination through the startAt and endAt parameters. Both parameters accept an existing object ID value and return objects in chronological order. The startAt parameter returns objects listed at and after the named object. The endAt parameter returns objects listed at and before the named object. These parameters are mutually exclusive. You can use either the startAt or endAt parameter, but not both simultaneously.

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?startAt=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?startAt=d210f054bf5b006f50aecbe1&limit=10",
        "previous": null
    }
}