Pagination
All endpoints which return an object list, support pagination with pagination information inside a pagination
object.
You can for instance list users, list banks or list transactions.
Bankin' uses a cursor based pagination via the after
and before
parameters.
If both parameters are provided, only before
is used.
Do not forge, nor store the
before
andafter
cursors as they may change overtime.
By default, all objects are ordered and paginated reverse chronologically with a
limit
of 50.
OPTIONS
limit integer | Number of results per call. Accepted values: 1 - 500. Default 50. |
before string | Cursor pointing to the end of the desired set. |
after string | Cursor pointing to the start of the desired set. |
RESPONSE
Paginated results are always returned in an array and include the following information in the pagination
object:
previous_uri | To make it easier, the API will build the previous call into previous_uri together with all the current pagination parameters.Can be null if the returned page is the first one. |
next_uri | To make it easier, the API will build the next call into next_uri together with all the current pagination parameters.Can be null if there are no more results in the list. |
curl "https://sync.bankin.com/v2/transactions?limit=2&client_id=TOP_SECRET_CLIENT_ID" \
-H "Authorization: Bearer TOP_SECRET_ACCESS_TOKEN"
{
"resources": [
{
"id": 9,
//...
},
{
"id": 8,
//...
}
],
"pagination": {
"previous_uri": null,
"next_uri": "/v2/transactions?limit=2&after=MzIx",
}
}
Updated over 4 years ago