Pagination metadata is included in response headers.
The Claimable API provides pagination metadata in the response headers when responding to your requests.
Not all endpoints support pagination, but those that do will include the following headers to help you traverse all records across multiple pages.
Pagination Response Headers
| Header | Description |
|---|---|
Link | The Link header was introduced in RFC 8288 and provides a standards-compliant way to refer to links for the previous page, next page and last page. |
Total-Count | The total number of records across all pages. |
Per-Page | The number of records included per-page. |
Current-Page | The current page. |
Total-Pages | The total number of pages. |
These headers tell you everything you need to know to make the multiple requests necessary to fetch all records that span multiple pages.