Skip to main content
List endpoints can return more results than you want to handle in one response. Cursor pagination lets you move through those results safely, while filters narrow the result set.
Not every list endpoint supports the same filters. Use the endpoint reference for the exact parameters available on each endpoint.

How cursor pagination works

A paginated response includes a pagination object:
If pagination.next contains a value, pass it back as the cursor query parameter. When it is null, you have reached the last page.
Cursors are opaque. Don’t edit, parse, or construct them yourself.

Request the first page

For GET /instances, size can be between 1 and 200. The default is 50.

Request the next page

Keep using the latest pagination.next value until it becomes null.

Filter instances

GET /instances supports filters for: The accepted region values are:
  • UAE
  • FR
  • US
Example:

Filter by date range

Date filters apply to started_at, not the time the instance record was created. An instance that has never started is excluded as soon as either date bound is used. Use ISO 8601 timestamps in UTC:

Search by text

List presets by region

GET /presets is also cursor-paginated and can be filtered by supported catalogue fields such as region.

Common issues

Next step

Continue with Handle errors and rate limits.