Pagination

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:

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'

const response = await fetch('https://{your-subdomain}.neetoform.com/api/external/v1/forms?page_number=2&page_size=25', {
  method: 'GET',
  headers: {
    'X-Api-Key': 'your-api-key',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://{your-subdomain}.neetoform.com/api/external/v1/forms"
params = {
    "page_number": 2,
    "page_size": 25
}
headers = {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json"
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print(data)

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
}

integer

The total number of items across all pages

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

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

Authentication HTTP Response Codes

Getting Started

Forms

Submissions

Team Members

V1 API (Deprecated)

Example Usage

Response Structure

Default Behavior

Best Practices

​Pagination Parameters

​Example Usage

​Response Structure

​Default Behavior

​Best Practices

Pagination Parameters

Example Usage

Response Structure

Default Behavior

Best Practices