📖Pagination

Some API endpoints return large datasets. To ensure efficient and manageable responses, these endpoints support cursor-based pagination. This allows clients to retrieve results in chunks and navigate through pages as needed. The response data includes a meta object that contains pagination-specific metadata.

Pagination Parameters

Below is a list of optional request parameters to control pagination of the response data.

Parameter	Type	Description
cursor	string	If the meta object contains a next_cursor field, it indicates that more records are available. To fetch the next set of records, include the cursor parameter in your request with the value of next_cursor. If the next_cursor field is not present, it means there are no more records to retrieve.
limit	integer	This parameter allows you to override the default limit of records returned, up to the max_allowed_limit specified in the response's meta object.
reverse_order	boolean	This parameter can be used to reverse the order in which the data is returned, useful for fetching the latest records first.

Response Example

{
    "data": [
        ...
    ],
    "meta": {
        "limit": 10,
        "max_allowed_limit": 50,
        "next_cursor": "eyJpZCI6MTA4MDMsIl9iYWNrd2FyZCI6ZmFsc2V9"
    }
}

• limit - The default number of records returned.

• max_allowed_limit - The maximum allowed limit of records per page.

• next_cursor - The token to use for retrieving the next set of records (see cursor request parameter).

The next_cursor field will indicate if there are more records to return. If not, the field will not be included in the response metadata.

Example Request

GET /v2/finplus/debtmanagement/financialtransactions?reverse_order=1&limit=100

Fetching the Next Page

GET /v2/finplus/debtmanagement/financialtransactions?reverse_order=1&cursor=abc123&limit=100