Guides
Pagination & Sorting
All list endpoints paginate results. Sorting works the same way on GET and POST endpoints - this page shows both.
Pagination
All list endpoints use offset-based pagination. Page numbers start at 1. Default page_size is 20. Max is 100 - if you pass a higher value, it caps at 100 (no error).
GET endpoints - query parameters:
?page=1&page_size=20
POST filter endpoints - request body:
"pagination": { "page": 1, "page_size": 25 }
Sorting
GET endpoints pass sort as a query parameter:
?sort=created_at,desc
POST filter endpoints include sort in the request body:
"sort": { "field": "created_at", "direction": "DESC" }
Valid directions: ASC (ascending) and DESC (descending).
Was this page helpful?