Skip to main content

Custom Pagination API Endpoints

You can paginate data returned from the REST API endpoints.

  • Limit the amount of data returned—The pageSize query string key is used to limit the amount of data returned from the API endpoint. If pageSize is not provided in the query string, then the default page size value of 10,000 is used.

  • Select a page of data—The page query string key is used to select a page of data returned from the API endpoint. Any filtering and/or sorting that is specified will be applied before the data is paginated as requested.

The API response header provides metadata detailing pagination information:

X-Pagination --> {"currentPage":1,"pageSize":10000,"totalCount":87,"totalPages":1,"prevPage":"","nextPage":""}

For an example of custom pagination API endpoints, see the following topic: