Skip to main content
Some API endpoints can potentially return large sets of data. e.g. the list orders or the list customers endpoints. Requesting the complete data set in one request can cause performance problems, so the API offers offset-based pagination to request data in more manageable chunks. You can use the query parameters offset and limit to request a certain part of the data. E.g. GET /partner/v1/customers?offset=0&limit=10 returns the first 10 records GET /partner/v1/customers?offset=10&limit=10 returns the next 10 records In the response, the API returns a count parameter that shows the number of records included the response, and a hasMoreItems flag that indicates whether there are more records in the list, so that your application can determine whether to issue another call to request the remaining records or whether it reached the end of the list.
Example
{
    "count": 10,
    "hasMoreItems": true,
    "data": [
        {
            "customerNumber": "8432478",
            "externalIdentifier": null,
            "firstName": "Erika",
            "lastName": "Mustermann",
            "businessName": null,
            "emailAddress": "[email protected]",
            "relations": [
                "Owner"
            ]
        },
        {
            "customerNumber": "5151465",
            "externalIdentifier": null,