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 | validation | mandatory |
|---|---|---|---|
| offset | Current recordset offset | integer | |
| limit | Current recordset limit | integer |
Additional Response Fields
parameter | description |
|---|---|
| total_entries | The total number of entries |
| offset | Current recordset offset |
| limit | Current recordset limit |
| first_page | Number representing the first page of the recordset (always 1) |
| last_page | Number representing the last page of the recordset |
| previous_page | The number of the previous page of the recordset (null if on first page) |
| next_page | The number of the next page of the recordset (null if on last page) |
| result | list of records |