Pagination
Endpoints that return lists let you page through large result sets with query parameters. Two patterns are used across the API; the endpoint's page in the API reference shows which parameters it accepts.
Limit and offset
The most common pattern uses limit (how many items to return) and offset (how many to skip). To walk through results, keep limit fixed and increase offset by limit each request.
# First page: items 1–25
curl "https://{{api_domain}}/api/reward/claim?limit=25&offset=0" \
--header "Authorization: Bearer {{access_token}}" \
--header "X-Tenant: {{tenant_id}}"
# Second page: items 26–50
curl "https://{{api_domain}}/api/reward/claim?limit=25&offset=25" \
--header "Authorization: Bearer {{access_token}}" \
--header "X-Tenant: {{tenant_id}}"
Page and page size
Some endpoints instead use page together with pageSize (or size). Pages are requested by number.
curl "https://{{api_domain}}/api/reward/type/{{organisation_type}}?page=0&size=25" \
--header "Authorization: Bearer {{access_token}}" \
--header "X-Tenant: {{tenant_id}}"
Note: Parameter names and defaults differ between endpoints, and not every list endpoint is paginated. Always check the Parameters table on the endpoint's page in the API reference before relying on a particular default.
Reading all pages
Request pages in a loop until a page returns fewer items than you asked for — that is the last page. Keep the page size reasonable and avoid firing requests faster than you need to.