Pagination

Harvest v3 uses a cursor-based pagination system to enhance efficiency and scalability.

How cursor-based links work

The paginated results include a Link header, adhering to the RFC-5988 specification. Each link includes a cursor parameter that encodes all relevant query parameters from the initial request.

Example of Link header:

Link: <https://api.example.com/resource?cursor=abc123>; rel="next"
  • The cursor parameter should not be combined with any additional query parameters.
  • All filtering and pagination settings from the initial request are embedded in the cursor itself.