Skip to main content
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:"1"
The page number to retrieve (starting from 1).
​
limit
integer
default:"25"
The 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

  1. Use page and limit query parameters when making requests to list endpoints.
  2. Respect the maximum limit of 100 items per page.
  3. Check totalPages to know when you’ve reached the last page.
  4. An empty items array with total: 0 means no results matched your query.

​
Limitations

  • The maximum allowed limit is 100 items per page.
  • If a limit greater than 100 is requested, the API will return a validation error.
  • Default limit varies by resource (20 or 25) but all cap at 100.