Pagination

List endpoints accept the same set of pagination query parameters.

Query parameters

integer

default:"1"

Which page to fetch. 1-indexed.

integer

default:"10"

Page size. Maximum 100.

string

Column to sort by. Valid column names depend on the resource — see the relevant endpoint page.

string

Sort direction. One of ASC or DESC.

Every paginated list returns the same envelope:

{
  "items": [ /* page of resources */ ],
  "total": 1284,
  "page": 1,
  "rowsPerPage": 10
}

Fetch the second page of customers, 25 per page:

curl -sf "$BASE/v1/customers?page=2&rows=25" \
  -H "Authorization: Bearer $TOKEN"

Condition	Field	Error
`rows > 100`	`page`	`rows value too large, must be less than 100`
`page < 1`	`page`	`page value too small, must be larger than 0`
Non-numeric `page` or `rows`	`page`	`page conversion: ...`