Skip to Content
API ReferencePagination

Pagination

All list endpoints return paginated results with a consistent format.

Request Parameters

ParameterTypeDefaultDescription
pagenumber1Page number (1-indexed)
limitnumber20Items per page (max 100)

Response Format

{ "data": [...], "pagination": { "page": 1, "limit": 20, "total": 156, "totalPages": 8, "hasMore": true } }

Fields

FieldDescription
pageCurrent page number
limitItems per page
totalTotal matching items
totalPagesTotal number of pages
hasMoreWhether there are more pages

Example

# First page GET /api/orders?page=1&limit=50 # Next page GET /api/orders?page=2&limit=50

Sorting

Most list endpoints support sorting via sort and order parameters:

GET /api/orders?sort=created_at&order=desc