Pagination

API responses often contain multiple records. Resource that return multiple records will contain 2 additional fields in addition to a more focused response that returns a singular record. The recordCount field indicates the total amount of available fields for the resource. The records field contains the returning records. This is specified with the recordCount attribute. E.g., for an endpoint with 14 records:

{
    "recordCount" : 14,
    "records" : [
    {
        ...
        ...
    }
   ]
}

Controlling the paging of returned API response is done so utilizing the below query parameters

  • Limits - controls the total quantity of returning records
  • Offset - indicated how many records to skip before displaying the quantity set by the limit

To skip the first 30 records and return then 20 accounts at a time:

(GET) https:// https://api.mxisoagent.com/boarding/v2/{resource}?limit=20&offset=30