Skip to main content

Pagination

Index actions are limited to 200 results per request unless otherwise specified. Where the number of results exceeds 200 records, the Clio Platform API will paginate the results.

Cursor Pagination​

Cursor pagination is the default pagination method in the Clio Platform API. Results are automatically ordered by id in ascending order. For example:

curl "https://api.clio.com/grow/v2/contacts?fields=id,name"

The Clio Platform API uses cursor-based pagination. Metadata about pagination is returned in the response body:

{
  "data": { ... },
  "meta": {
    "paging": {
      "previous": "https://api.clio.com/grow/v2/contacts?page_token=...",
      "next": "https://api.clio.com/grow/v2/contacts?page_token=..."
    }
  },
}

The previous and next fields will be URLs that can be used to retrieve the previous and next page of results. If there is no previous or next page, the field will be omitted.

How Cursor Pagination Works​

Cursor pagination has no upper limit to the number of records that can be accessed. As a trade-off, requests must be made in serial; the response from the initial pagination request will contain the URL of the next page in the meta.paging.next property, which means you must wait for the first page of results to return before requesting the next page.