How it works
The API starts returning results at the position indicated byoffset, then
returns up to limit records.
For example:
offset=0&limit=20returns the first 20 resultsoffset=20&limit=20returns the next 20 resultsoffset=40&limit=20returns the following 20 results
Example request
Pagination metadata in responses
Paginated responses may include metadata that helps you build next/previous navigation without recalculating offsets yourself. Common fields include:
Example response shape:
Recommended usage
- Start with
offset=0 - Use the response’s
nextOffsetvalue to request the next page - Stop when
hasNextPageisfalseornextOffsetisnull - Use a smaller
limitif you want faster, lighter responses