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 forms, 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.
​
integer
The total number of pages available.
​
integer
The number of items per page.
​
integer
The total number of items across all pages.

​
Default behavior

  • If you leave out page_number on the list forms and list submissions endpoints, you get all results in one response. These endpoints then ignore page_size.
  • If you leave out page_number on the list team members endpoint, you get the first page.
  • If you leave out page_size, each page has 30 items.

​
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.