All resources that use list API methods use page-based pagination.

​
Request Parameters

The following query parameters should be included in the request:
​
page
number
default:"none"
required
The page number to retrieve (starting from 1)
​
page_size
number
default:"10"
The number of items to return per page (maximum 100)

​
Meta Object Properties

The API response will include a meta object containing pagination information:
​
current_page
number
required
The current page number
​
page_size
number
required
The number of items per page
​
total_items
number
required
The total number of items across all pages
​
total_pages
number
required
The total number of pages
​
next_page_url
string
URL for the next page (if available)
​
previous_page_url
string
URL for the previous page (if available)
​
first_page_url
string
required
URL for the first page
​
last_page_url
string
required
URL for the last page

​
Best Practices

  1. Use page and page_size query parameters when making requests to list endpoints.
  2. Respect the maximum page_size limit of 100 items per page.
  3. Use the provided URLs in the meta object for navigation between pages.
  4. next_page_url or previous_page_url might be null.

​
Limitations

  • The maximum allowed page_size is 100 items per page.
  • If a page_size greater than 100 is requested, the API will return an error.