API Reference
Pagination
Core API endpoints that list records are returned in reverse chronological order, with the most recently created resource showing up first. You may optionally provide the following pagination parameters to limit the returned records.
Props
from_date
string
ISO 8601 formatted date (YYYY-MM-DD) to filter for records created on and after the date provided.
to_date
string
ISO 8601 formatted date (YYYY-MM-DD) to filter for records created on and before the date provided.
page
string
The number of the page to return.
page_cursor
string
The ID of a resource from which a page should start or end. Mutually exclusive with page
.
page_limit
string
The number of records to return per page.
Returns
Returns a list of the requested resource with the applied pagination. Additionally, the following headers are returned with the response:
Response pagination headers
Key | Description |
---|---|
Pagination-Page | The current page. |
Pagination-Page-Count | The total number of pages available. |
Pagination-Page-Limit | The number of records to return per page. |
Pagination-Total-Count | The total number of records matching the request. |
Pagination-Page-Cursor-Prev | The previous page cursor. |
Pagination-Page-Cursor-Next | The next page cursor. |