Skip to main content
The 1eye API uses cursor-based pagination for collection endpoints. Offset-based pagination is not supported.

Page size

Use the limit parameter to control the number of records returned in a request. Default:
Maximum:
Example:

Response

Collection responses include a pagination object containing next_cursor.
If next_cursor contains a value, additional results are available.

Retrieve the next page

Pass the returned next_cursor value using the cursor parameter.
Continue requesting pages until next_cursor is null.

Signals

Pagination works the same way for Signals. First request:
Next request:

When to stop

Always stop pagination only when:
Do not determine whether additional pages exist based on the number of records returned. For example, a page containing fewer records than the requested limit does not necessarily mean it is the final page. The API does not return a total result count in v1.

Cursor behavior

Cursors are generated by 1eye and should be treated as opaque values. Do not:
  • Construct cursors yourself
  • Modify a cursor
  • Decode a cursor
  • Reuse a cursor with a different endpoint
A cursor is tied to the endpoint, filters, and sorting used to create it. For example, a cursor returned by:
cannot be used with:

Keep filters and sorting consistent

When using a cursor to retrieve the next page, the following must remain unchanged:
  • Endpoint
  • Filters
  • sort_by
  • sort_order
For example, if the first request is:
the next request must use the same filters and sorting:

Changing the page size

The limit may change between pages. For example:
This is valid as long as the endpoint, filters, and sorting remain unchanged.

Invalid cursors

A malformed, modified, or mismatched cursor returns:
with the error code: