API calls with limit and page parameters allow you to control the amount of data returned in that call. To handle paging, include both parameters: limit for the size of the result set and page for which result set to return.
limit must be an integer, and must be supplied to return paged results. page must be an integer, and defaults to 1 if omitted. For example, to return the first 50 results you would append the following to your call:
To return the second set of 50 results, append:
Note: If you supply only the page parameter, you may receive unexpected results. Do not supply page without also supplying limit.
When using paging, the data portion of the response object changes to contain the paging information and subset of records. The structure changes to:
The fields contained:
- page: page of the result set returned
- current: index of the first row on this page; this is based on the total result set given the parameters supplied, not the first record's ID
- count: total number of records available given the parameters supplied
- pageCount: total number of pages given the parameters supplied
- data: result set of that page, structured as the data object normally is without paging active
Note: In some methods, some of these fields may not appear.