Pagination
Fintesk offers pagination for most of our API’s list and item collection endpoints.
Offset pagination
With the rest of our GET endpoints, we offer offset-based pagination. The parameters that control this type of pagination are start_page
and limit_by
, indicating the desired offset and the number of items to be returned per page.
start_page (integer) | Pagination start. If omitted, the default value is 0. |
limit_by (integer) | The number of items shown per page. If not provided, 50 items will be returned. |
Example request for the GET /v1/activities
endpoint:
GET https://api.fintesk.com/v1/activities?start=0&limit=100
Within the response’s additional_data
object, a pagination object will be returned. The additional_data.pagination
object will contain the given start_page
and limit_by
values, as well as the more_items_in_collection
flag, indicating whether more items can be fetched after the current batch.
If more items can be fetched, the next_start
field, which can be used for specifying the next offset pointer, will also be returned.
The maximum limit_by
value is 500.
Example response:
{
"success": true,
"data": [{
… // returned activities’ data
}],
"additional_data": {
"pagination": {
"start": 0,
"limit": 10,
"more_items_in_collection": true,
"next_start": 10
}
}
}