Pagination and Metadata

Some APIs return paginated lists of records, wrapped in metadata. These APIs also have additional request fields to control pagination.

Additional Request Fields

parameter
description
validationmandatory
offset

Current recordset offset

integer 
limitCurrent recordset limitinteger 

Additional Response Fields

parameter
description
total_entries

The total number of entries

offsetCurrent recordset offset
limitCurrent recordset limit
first_pageNumber representing the first page of the recordset (always 1)
last_pageNumber representing the last page of the recordset
previous_pageThe number of the previous page of the recordset (null if on first page)
next_pageThe number of the next page of the recordset (null if on last page)
resultlist of records