When using GET requests to query for lists of data it is essential to limit the amount of data that one receives to reduce the response times. Several GET request endpoints that return a list of objects have 2 query parameters available to page the data. These query parameters are 'Page' and 'PageSize' which take int32 as input.

📘
Automatic pagination page size is set 100 items
If you do not provided a page size, the api will automatically return at maximum 100 items to prioritise request response time.

📘
Maximum pagination page size is set 1500 items
The maximum number of items that can be retrieved is 1500.

Response headers

When using pagination the endpoint will return two new headers. These headers are X-Total-Pages and X-Total-Count.

X-Total-Pages returns an integer that indicates how many pages of data are available with the provided page size. X-Total-Count returns an integer indicating how many different instances of the object are present.

Example

Requesting a list of customers with pageSize set to 50 and page set to 1. If there are 125 customers that fit your criteria then you will receive the first 50. The X-Total-Pages header will be 3 and the X-Total-Count header will be 125. If you pass page as 3 then you will receive the final 25 customers.

👍
Limit the page size depending on your use case.
Use the pageSize and page number query parameter to select specific data from a large list.