Pagination

The List voters of a feature request, List feature requests a customer voted for and List changelogs APIs are paginated. Search feature requests is not paginated. It takes per_page instead, with a maximum of 15 results. List tracks returns all tracks in one response.

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. The maximum is 100.

Example usage

Here’s how to retrieve paginated results:

curl --request GET \
  --url "https://{your-subdomain}.neetoengage.com/api/external/v1/changelogs?page=2&page_size=10" \
  --header 'X-Api-Key: your-api-key'

const response = await fetch(
  "https://{your-subdomain}.neetoengage.com/api/external/v1/changelogs?page=2&page_size=10",
  {
    method: "GET",
    headers: {
      "X-Api-Key": "your-api-key",
      Accept: "application/json",
    },
  }
);

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

import requests

url = "https://{your-subdomain}.neetoengage.com/api/external/v1/changelogs"
params = {
    "page": 2,
    "page_size": 10
}
headers = {
    "X-Api-Key": "your-api-key",
    "Accept": "application/json"
}

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

This retrieves the second page of changelogs, with 10 results per page.

Response structure

Paginated responses include the pagination fields at the top level, next to the list of records:

Response example

{
  "changelogs": [
    // ... array of changelog objects
  ],
  "page": 2,
  "page_size": 10,
  "total_count": 34,
  "total_pages": 4
}

integer

The current page number.

integer

The number of items per page.

integer

The total number of items across all pages.

integer

The total number of pages available. This is at least 1, even when there are no items.

Default behavior

If you leave out page, you get the first page.
If you leave out page_size, each page has 25 items.
A page_size above 100 is lowered to 100.
A page past the last one returns an empty list.

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_pages: Stop when page reaches total_pages.

Getting started

Feature requests

Votes

Tracks

Changelogs

Settings

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