All list endpoints use page-based pagination with consistent request parameters and response structure.
Request Parameters
Include these query parameters on any list endpoint:
page integer default: 1The page number to retrieve (starting from 1).
limit integer default: 25The number of items to return per page (minimum 1, maximum 100).
Response Structure
List endpoints return an object with items and pagination:
{ "ok": true, "data": { "items": [], "pagination": { "page": 1, "limit": 25, "total": 142, "totalPages": 6 } }}Pagination Object
page integer required The current page number.
limit integer required The number of items per page.
total integer required The total number of items across all pages.
totalPages integer required The total number of pages.
Best Practices
- Use
pageandlimitquery parameters when making requests to list endpoints. - Respect the maximum
limitof 100 items per page. - Check
totalPagesto know when you’ve reached the last page. - An empty
itemsarray withtotal: 0means no results matched your query.
Limitations
- The maximum allowed
limitis 100 items per page. - If a
limitgreater than 100 is requested, the API will return a validation error. - Default
limitvaries by resource (20 or 25) but all cap at 100.