Pagination

Overview

When making calls to the Acquired.com API, a lot of the time, there will be a number of results to return. Our API supports the requirement for multiple objects to be returned in a list. For that reason, we paginate the results to make sure the servers can handle the responses.

We set the default number of objects returned to 25 and the maximum to 100. If you do not specify any query parameters you will receive the most recently created 25.

If the request exceeds the maximum amount, it will either return a 400 - Bad Request response or limit the values returned to 100 regardless of the request exceeding that limit.

Query parameters

The parameters defined by the developer.

FieldTypeDescriptionDefault
filterstringFilter the parameters that you want to return within the response.N/A
limitintegerA limit on the scope of values returned in the response. This can either be the requested number (with a maximum of 100) or if left blank the first 25 results would be returned.25
offsetintegerThe record to start the response on.0

📘

Note

When appending the query parameters to your request, you must put the filter parameter first.

Request

{{url}}/customers?filter=customer_id,dob,last_name?limit=30?offset=2

Response

{
    "meta": {
        "count": 30,
        "offset": 2,
        "limit": 30,
        "total": 88
    },
    "data": [
    {
            "customer_id": "a98540950-hf543...",
            "dob": "1994-01-20",
            "last_name": "Barrow"
        },
        {
            "customer_id": "j5849459-jk454...",
            "dob": "1991-09-25",
            "last_name": "Smith"
        }
  ]
}

Metadata responses

This allows the developer to know how many records and pages there are in total within the response.

FieldTypeDescription
countintegerThe number of records returned as part of the response.
offsetintegerThe starting record number.
limitintegerThe maximum number of records that can be returned as part of the response.
totalintegerThe total number of records contained in the query response.

See below example metadata responses:

Assume that there are 77 records as part of the GET /customers examples and look at the responses for metadata.

/customers

{
  "meta": {
    "count": 25,
    "offset": 0,
    "limit": 25,
    "total": 77
  },
  "data": [
    ]
}

/customers?limit=15

{
  "meta": {
    "count": 15,
    "offset": 0,
    "limit": 15,
    "total": 77
  },
  "data": [
    ]
}

/customers?offset=5

{
  "meta": {
    "count": 25,
    "offset": 5,
    "limit": 25,
    "total": 77
  },
  "data": [
    ]
}

/customers?offset=5&limit=5

{
  "meta": {
    "count": 5,
    "offset": 5,
    "limit": 5,
    "total": 77
  },
  "data": [
    ]
}