Pagination

Overview

This guide shows you how to paginate your API responses.

Some APIs that list or retrieve collections of items may return large volumes of data in a single response. This can lead to server strain, timeouts, or system failures. To conserve resources and improve performance, use pagination to divide data into smaller, manageable units. Clients can control the range of data and retrieve only what they need.

Akkuro Lending supports offset-based pagination in list and search endpoints by using the offset and limit query parameters.

Paginate API responses

Send a GET request to the endpoint, including the offset and limit as query parameters.

Parameter	Type	Description	Required
offset	Number	The number of items to skip before starting to return results.	No
limit	Number	The maximum number of items to return. Must be between 1 and 100.	No

Request example

Suppose you make a request to the API to retrieve a list of all counterparties. In this example, the request sets the parameters as follows:

• offset=100 skips the first 100 items and starts from the 101st.
• limit=50 retrieves the next 50 items.

curl --location --request GET 'https://api.eu.lending.akkuro.io/counterparty-management/counterparties?limit=50&offset=100' \
--header 'Accept: application/json;api-version=2025.1.0' \
--header 'Authorization: Bearer YOUR_JWT_HERE' 

Response example

The API returns the requested items along with pagination metadata, such as:

• The total number of items available (total count).
• The current offset and limit used in the request.

{
    "items": [
        {
            "type": "mortgage",
            "deed": {
                "currency": "EUR",
                "amount": 672000.0
            },
            "registeredMortgageEntries": [
                {
                    "type": "registeredMortgageEntry",
                    "collateralObjectReferenceId": "string",
                    "isAlreadyPledged": false,
                    "rank": 1
                }
            ],
            "referenceId": "string",
            "tenantFormattedReferenceId": "string",
            "collateralDefinitionCode": "HTD",
            "startDate": "2022-11-01",
            "coverAmount": {
                "currency": "EUR",
                "amount": 800000.0
            },
            "isPerfect": false,
            "agreementReferenceIds": [
                "string"
            ]
        }
        ...
    ],
    "total": 166,
    "offset": 100,
    "limit": 50
}