Depending on your organisation's usage profile, our API provides access to potentially large numbers of records.
Often you might be asking for too much information, and in order to keep our platform performing well, the API automatically paginates the requested items.
Pagination means that if the result of your request is a lot of items, we will only return a slice of this result at a time - we call each slice a page.
All our collection / search style APIs implement pagination, and as such you must cater for this when you connect to our platform.
- Specify the page (i.e. the slice) of the result set you wish to receive by using the PageNo parameter found on all our collection/search APIs.
By default, all paginated APIs start at PageNo of 0, which is the first page of the result set.
- Specify how many items to receive by using the PageSize parameter found on all our collection/search APIs.
By default this is set to our default maximum of 100 items per request.
There are a few exceptions on some of our higher volume APIs. For example, our SList Search API has a default of 1000 items.
- All our paginated APIs return a TotalRows value in the response which tells you the total number of rows available for your request parameters.
Using the PageSize you passed into your request, you can calculate how many pages of data you can request.
i.e. PageSize / TotalRows = Total number of pages
- Once you know how many pages are available, you can make progressive API requests, iterating through the result set page by page.