Skip to main content

Pagination

Conduitt list endpoints default to offset pagination, with cursor pagination available on clients and invoices.

The current pagination contract for public list endpoints is:

  • every list endpoint accepts bounded offset pagination
  • cursor pagination is also available on clients and invoices when you pass pagination=cursor

Offset Pagination

Use these query parameters on list endpoints in the default mode:

  • limit: page size, bounded by the endpoint
  • offset: number of matching records to skip

Example:

curl "https://api.conduitt.io/clients?limit=25&offset=0" \
  -H "Authorization: Bearer ck_test_your_key"

Cursor Pagination

Opt in with pagination=cursor, then use:

  • first
  • last
  • after
  • before
  • orderBy
  • orderDirection

Example:

curl "https://api.conduitt.io/invoices?pagination=cursor&first=20&orderDirection=desc" \
  -H "Authorization: Bearer ck_test_your_key"

Cursor Response Shape

Cursor responses include:

  • edges
  • pageInfo
  • totalCount

The server also includes a Link header for cursor navigation metadata.

Guidance

  • use offset mode for list, search, and admin pages
  • use cursor mode when you need stable traversal over larger changing datasets
  • do not mix older starting_after and ending_before examples from stale docs with Conduitt’s current cursor parameters

We use cookies to improve your experience, analyze traffic, and personalize content.