The Bokio API supports pagination to retrieve large sets of data in smaller, manageable chunks. This document provides an overview of how pagination works in the Bokio API.
Pagination Parameters
When making a request to an API endpoint that supports pagination, you can include the following parameters:
page: Specifies the page number to retrieve. The default value is 1.pageSize: Specifies the number of items per page. The default value is 25, and the maximum value is 100.
Response Body
The API response includes the following fields related to pagination within the JSON body:
totalItems: Indicates the total number of items available.totalPages: Indicates the total number of pages available.currentPage: Indicates the current page number.
Example Request
To retrieve the first page of results with a pageSize of 50 items per page, you can make the following request:
GET some-operation?page=1&pageSize=50 HTTP/1.1
Example Response
The API response will include the requested page of results, along with the pagination information within the JSON body:
HTTP/1.1 200 OK
{
"result": [
// Results here
],
"totalItems": 1000,
"pagePages": 20,
"currentPage": 1,
}