Parameters
The pagination of the API provides information about the objects if available.
This section outlines the pagination parameters, shows a sample response, and describes the fields that are returned in the response. It also provides important notes about pagination.
The following table lists the pagination parameters that you can set:
Parameter | Description | Notes |
|---|---|---|
startIndex | Specifies the starting index of the element. | Zero-based: 0 is the first element. DEFAULT = 0. |
resultsPerPage | Specifies the number of elements to retrieve. | MIN=1, DEFAULT=25, MAX=50. |
If you do not specify both startIndex and resultsPerPage parameters, then the pagination with default resultsPerPage parameter with the maximum value is taken.