For API calls made on top-level objects, the Ironclad Clickwrap REST API will provide a list of results. For example, if you do a GET
call on the /activity
route, you will receive a set of results (if multiple activities exist on the Account/Site, which will be limited to 25 by default. With the response data and available API URL parameters, you'll be able to page through results with the page
and per_page
parameters.
Example:
{
"page": 1,
"per_page": 25,
"count": 11,
"total_count": 11,
"has_more": false,
"data": [
{
"event_type": "reminded",
},
{
"event_type": "reminded",
},...
]
}
Due to the ability for some objects to contain a great amount of information, we recommend the following while using pagination:
- Keep
per_page
no greater than 100 - Limit the number of concurrent requests happening through pagination
- Utilize the
has_more
property in the response to check if additional API calls need to be made