API Results Pagination

PAPE uses cursor based pagination for all GET endpoints that returns a list of results.

All returned items have a pagingToken field that you can use to specify where your requests should start, or end.

_size

Use the _size query parameter to limit the number of items returned in a request.

Use the _sort query parameter to sort the list of returned items. The format of the _sort query is:

fieldName.order,otherFieldName.order

e.g. name.asc,pagingToken.desc

Rather than sorting by createdAt, it is best to use pagingToken as your chronological sort field.

Returned results will all have pagingToken > _after.

Returned results will all have pagingToken < _before

Use a fieldName to filter out results with items that exactly match that fieldName property.

e.g. status=pending, will only include items that have status == pending.