Some top-level API resources support bulk data retrieval via list endpoints. For example, you can retrieve a list of contract cancellation requests using the corresponding endpoint.
These list methods follow a consistent structure and accept two optional query parameters:
page_size: Specifies the maximum number of items to return per page.page_token: A cursor used to retrieve the next page of results.
Evy implements cursor-based pagination using the page_token parameter. To fetch subsequent pages, pass the next_page_token or the prev_page_token value returned in the previous response as the page_token in your next request. This allows you to reliably navigate through large datasets page by page.
Parameters
| field | type | description |
|---|---|---|
| page_size | nullable int | This specifies a limit on the number of objects to return, ranging between 1 and 100. Default is 10. |
| page_token | nullable string | A cursor used for pagination. It indicates the position in the list from which the next set of results should be returned. For example, if you make a list request and receive 100 items along with a next_page_token, you can pass that token as page_token in your next request to retrieve the following page of results. |
List Response Format
| field | type | description |
|---|---|---|
| object | string, value is "list" | String representing the object’s type. |
| data | array | An array containing the actual response elements, paginated by any request parameters. |
| pagination | nullable object | A pagination object containing a next_page_token field. |
| pagination.next_page_token | nullable string | An opaque cursor representing the next page to be fetched. If this field is null, there are no additional pages. |
| pagination.prev_page_token | nullable string | An opaque cursor representing the previous page to be fetched. If this field is null, there are no prior pages. |