All API responses which support pagination will include a top level pagination fragment in the JSON response body.
Pagination Query Parameters
All APIs supporting recognizes the following request parameters for pagination:
| Parameter | Description |
|---|---|
| page | The page number, starting at 1 |
| size | The size of each page, with a max of 100 |
Pagination Response Fragment
All API responses which support pagination will include a top level pagination fragment in the JSON response body, which looks like:
"pagination": {
"page_number": 1,
"page_size": 20,
"total_records": 255
}
With the above information, you can infer how many pages there are and iterate until the list is exhausted.
Ready to take a closer look at Bonsai?
Find out if Bonsai is a good fit for you in just 15 minutes.