Pagination
Requests that return multiple items will be paginated to 20 items by default. You can specify pagination with the limit
and offset
parameters.
Parameters
Name | Type | Description | Default |
---|---|---|---|
limit | integer | Defines the total items that should be returned in the response | 20 |
offset | integer | Defines the beginning of the subset of items. | 0 |
Links
The pagination info is included in the JSON response. It is advised to follow these values instead of constructing your own URLs.
{
"links": {
"self": {
"href": "https://demo.joomlatools.com/en/docman/hierarchical-list?view=documents&format=json&offset=20",
"type": "application/json; version=1.0"
},
"next": {
"href": "https://demo.joomlatools.com/en/docman/hierarchical-list?view=documents&format=json&offset=40",
"type": "application/json; version=1.0"
},
"previous": {
"href": "https://demo.joomlatools.com/en/docman/hierarchical-list?view=documents&format=json&offset=0",
"type": "application/json; version=1.0"
}
}
}