Pagination

By default all endpoints that return lists, return paginated results. Request pages using the offset and limit query parameters.

For example, the following request body will return the first page, with up to 10 lines:

{
  "integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "offset": 0,
  "limit": 10,
  "search": [
    {
      "path": "Processor",
      "search": {
        "type": "string",
        "value": "Braintree"
      }
    }
  ]
}

To request the next page, update the offset query parameter:

{
  "integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "offset": 10,
  "limit": 10,
  "search": [
    {
      "path": "Processor",
      "search": {
        "type": "string",
        "value": "Braintree"
      }
    }
  ]
}

The maximum offset value is 500.