Paging
Some API resources on Phaxio are paged because of the size of the information that can potentially be returned.
Paged operations can be controlled by passing Phaxio paging parameters. Information about the size of a
resource’s returned results can be found in the HTTP response headers as well as the paging
attribute of the
resource’s response.
Paging parameters that can be passed to Phaxio
Name |
Description |
per_page |
The maximum number of results to return per call or "page" (1000 max). |
page |
The page number to return for the request. 1-based. |
Name |
Description |
X-Total |
The total number of results available for the request.
For result sets that contain greater than 10,000 records, the string ">10000" will be returned.
|
X-Per-Page |
Maximum number of results returned per call or "page". |
X-Page |
The current page number. 1-based. |
Paging attributes found in Phaxio API responses
Name |
Description |
total |
The total number of results available for the request.
For result sets that contain greater than 10,000 records, the string ">10000" will be returned.
|
per_page |
Maximum number of results returned per call or "page". |
page |
The current page number. 1-based. |