Pagination Parameters
You can control pagination using the following query parameters:integer
The page of results you want to retrieve (starting from 1)
Example Usage
Here’s how to retrieve paginated results using cURL:Response Structure
Paginated responses include metadata about the pagination in JSON format:Response Example
integer
The total number of items across all pages
integer
The current page number (if pagination was used)
integer
The total number of pages available (if pagination was used)
integer
The number of items per page in the response
Default Behavior
If the
page_number parameter is not provided, default values will be applied:- page_number: 1 (first page)
- page_size: 30 (30 items per page)
Best Practices
- Start with reasonable page sizes: Expect ~30 items per page by default.
- Handle empty results: Always check if the returned array is empty to detect the end of data.
- Use pagination metadata: Use the
pagination.total_recordsfield to calculate the total number of pages needed. - Implement error handling: Handle cases where the requested page doesn’t exist.