Pagination

All list endpoints in the Opally API use cursor-based pagination. This provides consistent, reliable results even when new data is being created.

How It Works

List endpoints return a pagination object alongside the data array:

{
  "data": [...],
  "pagination": {
    "has_more": true,
    "next_cursor": "2026-03-10T14:30:00.000Z"
  }
}
  • has_moretrue if there are more results after this page

  • next_cursor — pass this value as the cursor parameter to fetch the next page. null when there are no more results.

Parameters

Parameter
Type
Default
Description

cursor

string

Cursor from a previous response to fetch the next page

limit

integer

25

Number of items per page (min: 1, max: 100)

Example: Paginating Through Results

Sort Order

All list endpoints return results sorted by newest first (descending by timestamp). Pagination cursors advance through results from newest to oldest.

Date Filtering

Most list endpoints support date range filtering:

Parameter
Type
Default
Description

from

ISO 8601 string

30 days ago

Start of the date range

to

ISO 8601 string

Now

End of the date range

circle-info

Date values are parsed as UTC. Use ISO 8601 format: 2026-01-01, 2026-01-01T00:00:00Z, or 2026-01-01T00:00:00.000Z.

circle-exclamation

Last updated