Pagination, filtering & sorting

List endpoints accept filtering, sorting, and pagination as query parameters on the collection root (e.g. GET /api/colors?state=active&pageSize=30).

Two pagination modes

Pagination has two mutually exclusive modes on the same endpoint:

Page-based
Cursor

Use pageSize and pageNumber together with any filter and sort:

GET /api/colors?state=active&pageSize=30&pageNumber=2

Pass the cursor returned by the previous response. The cursor already encodes the filter and sort that produced it:

GET /api/colors?cursor=eyJTaWduYXR1cmUiOi...

cursor is mutually exclusive with pageNumber, pageSize, filter, and sort. Sending cursor together with any of those returns 400 Bad Request.

The pagination object

List responses include a pagination block:

{
  "pagination": {
    "hasMore": true,
    "cursor": "eyJTaWduYXR1cmUiOi..."
  }
}

To fetch the next page, send the returned cursor back on the same endpoint.

Filtering

As much as possible, every field in the response is available as a query-parameter filter, and filter values match the format returned in responses (e.g. state=active, not state=1).

Getting Started

Concepts

Guides

Pagination, filtering & sorting

Filtering

​Two pagination modes

​The pagination object

​Filtering

Two pagination modes

The pagination object

Filtering