Overview

Pagination

How to use pagination on our API.

This guide will show you how to use pagination on our API.

If not specified, all response return 10 elements but you can go as high as 1000 by using the size parameter.

Response

  • data*object[]

    Contains the list of documents returned by the request.

  • size*integer

    Number of records per page requested.

    Example: 3
  • has_next*integer

    true if there are more records available.

    Example: true
  • count*integer

    Number of records returned in the current page.

    Example: 2
  • search_after*string | null

    The cursor to use to get the next page of results.
    Note: This value is not always equals to the id of the last document.

    Example: "2"
Example of a response
{
  "data": [
    {
      "id": "1",
    },
    {
      "id": "2",
    }
  ],
  "size": 2,
  "has_next": true,
  "count": 2,
  "search_after": "2"
}