Pagination

Pagination

List endpoints support limit and offset parameters to control how many rows are returned and where the result set begins.

GET /v1/books?limit=25&offset=50

This request returns 25 rows starting at row 50 (zero-based index).

Limit

The limit parameter controls how many rows Conduit returns. If omitted, Conduit uses the server's default_limit value.

GET /v1/books?limit=10

If the client requests a limit larger than the configured maximum, Conduit clamps it to the allowed maximum.

Offset

The offset parameter specifies how many rows to skip before returning results.

GET /v1/books?offset=100

Offset is useful for paging through large datasets.

Limit + Offset

Limit and offset can be combined to implement full pagination:

GET /v1/books?limit=20&offset=40

This returns rows 40-59.

Sorting

Pagination works together with sorting. When using order, the limit and offset apply after sorting.

GET /v1/books?order=title&limit=10&offset=20

This returns the third page of results sorted alphabetically by title.

Filtering

Pagination also works with where filters. The filter is applied first, then sorting, then pagination.

GET /v1/books?where=author='Asimov'&limit=5&offset=10

Supported Formats

Pagination works across all output formats:

• JSON
• YAML
• XML
• TOML
• CSV
• NDJSON

NDJSON streams one record per line, but still respects limit and offset.

Notes

• Pagination applies to all tables automatically.
• Default limits are configured in server.default_limit.
• Large offsets may impact performance depending on the database driver.
• Pagination is applied after filtering and sorting.
• Offset is zero‑based.