Overview
Alllist() methods return a Page<T> object. Every page includes the data list, metadata about the total result set, and links to the next/previous page.
The Page Object
All model fields in Java records are accessed via method calls (e.g.
page.meta().total(), not page.meta().total).Manual Pagination
Control pagination yourself withpage and perPage parameters:
Auto-Pagination with iter()
Every resource exposes an iter() method that automatically fetches all pages and yields individual items:
iter() uses PageIterator<T>, which calls list() repeatedly and follows links().next() until there are no more pages.
Collecting into a List
If you need all results in aList, iterate and collect:
Early Stopping
Break out of aniter() loop at any point — no extra pages are fetched after the break:
Progress Reporting
Pagination Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | int | 1 | Page number (1-indexed) |
perPage | int | 20 | Items per page (max 100) |
