Skip to main content

​
Pagination Parameters

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

​
Example Usage

Here’s how to retrieve paginated results: 
curl --request GET \
  --url "https://{your-subdomain}.neetoform.com/api/external/v1/forms?page_number=2&page_size=25" \
  --header 'X-Api-Key: your-api-key'
This retrieves the second page of forms, with 25 results per page.

​
Response Structure

Paginated responses include pagination metadata:
Response Example
{
  "forms": [
    // ... array of form objects
  ],
  "pagination": {
    "total_records": 150,
    "total_pages": 6,
    "current_page_number": 2,
    "page_size": 25
  },
  "total_count": 150
}
​
total_count
integer
The total number of items across all pages
​
pagination
object
Pagination metadata. Contains total_records (total items), total_pages, current_page_number, and page_size.

​
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_count: Use the total_count field to calculate the total number of pages needed.
  4. Implement error handling: Handle cases where the requested page doesn’t exist.