Skip to content

Pagination and search

List endpoints (GET /<resource>) accept:

ParamDefaultMeaning
limit10Items per page. Use -1 to return all items.
page11-indexed page number.
orderByresource defaultField to sort by.
orderascasc or desc.

Responses include:

  • X-Total-Count header with the unfiltered total.
  • Link header with prev, next, last relations (RFC 5988).

POST-based search lives at /<resource>/search. It accepts the same fields as the resource model, plus a filters object for structured matches. Use search when:

  • You need substring or partial matches.
  • You need to filter on nested fields.
  • The list endpoint’s query params aren’t expressive enough.

Search responses follow the same pagination contract as list endpoints.