Pagination

The API calls that retrieve data will contain the following code:

"metadata": {
      "results": {
         "first": 1,
         "last": 100
      },
      "total_results": 490
   }

The default number of records returned is 100, but there two URL parameters that can be used to change that and to navigate among the pages:

  • limit: it can be any integer number between 1 and 1000. It will limit the number of records returned by the call
  • start: it indicates the number of records to skip from the first position

These parameters are case insensitive and can be appended to the URL endpoint: they will not be accepted in the body of the request.

Examples:
https://g001.enterprise.ipost.com/api/v1/clienttoken/contacts/search/?start=290
https://g001.enterprise.ipost.com/api/v1/clienttoken/DataTables/101/retrieve/?limit=1
https://g001.enterprise.ipost.com/api/v1/clienttoken/lists/25/contacts/?limit=10&start=400

Below is an example of the "metadata" item returned with the parameters as per the call above:

"metadata": {
      "results": {
         "first": 401,
         "last": 410
      },
      "total_results": 490
   }