Overview

All endpoints that list objects provide support for pagination. This allows you to retrieve a subset of the results at a time, making it easier to manage large datasets.

Pagination Parameters

Pagination is controlled using the following query parameters:

take
string
default: 10

The number of items to return per page.

from
Id

The cursor indicating where to start fetching the next set of results. It corresponds to the ID of the first item on the current page.

If not provided, the API will start fetching from the newest item.

Response Structure

The paginated response has the following structure:

{
  "data": [...],
  "links": {
    "previous": "<url>",
    "next": "<url>"
  }
}

Response Attributes

data
array

The list of items for the current page.

links
object

URLs to navigate to the previous and next pages.

previous
url | null

The URL to fetch the previous page of results.

next
url | null

The URL to fetch the next page of results.

We advise using the next and previous links to navigate through the results directly, avoiding manual cursor calculations or URL parsing