Pagination

For GET / requests that list entities, the standard response includes the total number of entities available (total property), the number of returned entities (limit property) and the number of entities that have been skipped (skip property).

A standard response looks like this:

{
"total": 100,
"limit": 10,
"skip": 0,
"data": [
...
]
}

You can control this behavior and paginate the returned entities with the following query-string parameters:

Parameter

Description

$limit

Number of items to return (it usually has to be lower than 100)

$skip

Number of skipped items (ie offset of the first item to be returned)