Skip to main content

​
Pagination Parameters

You can control pagination using the following query parameters:
​
integer
The page of results you want to retrieve (starting from 1).
​
integer
The number of items to return per page.

​
Example Usage

Here’s how to retrieve paginated results:
This retrieves the second page of bookings, with 25 results per page.

​
Response Structure

Paginated responses include metadata about the pagination:
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.

​
Default Behavior

If pagination parameters are not provided, default values will be applied:
  • page_number: 1 (first page)
  • page_size: 30 (30 items per page)

​
Best Practices

  1. Start with reasonable page sizes: Use page sizes between 10-100 items for optimal performance.
  2. Handle empty results: Always check if the returned array is empty to detect the end of data.
  3. Use total_records: Use the pagination.total_records field to calculate the total number of pages needed.
  4. Implement error handling: Handle cases where the requested page doesn’t exist.