Pagination

When retrieving information using GET methods of the REST API, the optional pageSize query parameter sets the maximum number of rows to return in a response. The maximum is 40; larger values are treated as 40. If this value is empty or invalid, pageSize typically defaults to 10.

The default value for the maximum number of rows retrieved can be overridden at the method level.

If more rows are available, the response will include a nextPage field, which contains a URL for requesting the next page. If this value is returned, you can use the URL to retrieve the next page of the response. In some circumstances, the next page might be empty. If this value is not returned, no more rows are available.

Array Size

For data items that are not paginated, the REST API supports arrays of up to 300 rows. Thus, for instance, repeated pagination can retrieve thousands of customer accounts, but within any account an array of no more than 300 rate plans is returned.