Pagination
All API resources that can return multiple records (eg. the payments API) are paginated. These endpoints provide the same set of parameters that allow you to specify which page and how many records per page to return.
Query parameters
| Parameter | Default | Description |
|---|---|---|
| page | 1 | The current page. |
| perPage | 50 | The number of records to return per page (maximum: 100). |
| offset | 0 | The offset to start from. |
Response headers
The following pagination headers are included in the response. All pagination headers are integers.
| Header | Description |
|---|---|
| X-Total | The total number of records in the query. |
| X-Total-Pages | The number of pages that the query is made up of. |
| X-Page | The current page. |
| X-Per-Page | The number of records per page. |
| X-Next-Page | The next page. |
| X-Prev-Page | The previous page |
| X-Offset | The offset being used. |