Paginating API Request Results

Break up your large result sets into manageable pages of data

Peter Novosel avatar
Written by Peter Novosel
Updated over a week ago

Most endpoints that return multiple results can be instructed to return results in pages to reduce the size of individual responses. By default each endpoint will return all entities requested, but you can explicitly set the page size by appending a "limit" parameter to the request URL, like this:[ID]/records/list/?limit=100

This will have the effect of returning the first 100 items. You can retrieve subsequent pages by specifying an offset value:[ID]/records/list/?limit=100&offset=100

This will tell the API to ignore the first 100 items and send the next 100.

The total number of results is contained in the total property:

"total": 5000,
"offset": 0,
"limit": 0,
"items": [

Did this answer your question?