Multiple Pages

Some API endpoints may retrieve multiple pages of infomation when the result set contains more than 25 records. When this happens, the x-PageCurrent and x-PageMax header responses will be returned. When no x-ApiPage parameter is sent, the first page will be returned.

x-PageCurrent - If there are more than one page of information, this provides the current page number sent. x-PageMax - If there are more than one page of information, this provides the total number of pages.

To specify a page to return, send the following into your request: x-ApiPage - If there is more than one page to retrieve (shown by the header x-PageMax), the page number to retrieve is specified here. The first page is always returned if this parameter is not passed.