Pagination

Pagination

The response of each request contains a list of entries.

As this list may be large, by default only the first 10 entries are presented.

To indicate that more results may be available, and to instruct the user how to get
them, the response object contains paging information.

The response object

The OpenAPI definitions for the response object are:

{
    "items": {
        "type": "array",
        "items": {
            "type": "object"
        }
    },
    "count": {
        "type": "integer",
        "description": "The amount of entries in the `items` property",
        "example": 1
    },
    "total": {
        "type": "integer",
        "description": "The total amount of entries returned in this search",
        "example": 9
    },
    "next": {
        "type": "integer",
        "description": "The index of the first item in the next page, as should be passed to the `from` query parameter",
        "example": 2
    },
    "prev": {
        "type": "integer",
        "description": "The index of the first item in the previous page, as should be passed to the `from` query parameter",
        "example": 0
    }
}

Syntax

Return entries from index `<from>`

?from=<from>

Return `<length>` entries

?length=<length>
?from=<int>&length=<int>

Return `<length>` entries from index `<from>`

?from=<from>&length=<length>

Examples

Example query parameters	Entries in response
`?` (empty)	[`0`, `9`]
`?from=100`	[`100`, `109`]
`?length=200`	[`0`, `199`]
`?from=100&length=200`	[`100`, `299`]

Limitations

The maximum value of the length parameter is 1000.

Updated about 2 months ago