Scroll API

You can use Scroll API to retrieve a large number of results (or even all results) from a single query.

It does not support the skip parameter and only lets you request the next page through the resource. You can continue paging until it no longer returns results or you have reached the last page.

Scroll only supports the GET method. The only difference with the Querying API is the paging arguments.


Scroll takes a snapshot of the result set the first time you execute a query. This snapshot is maintained for a limited amount of time and prolonged on every next page request. It is not a live view of the database and can contain already modified or deleted data.

This resource is available at the following URL:

// [!code word:<HOSTNAME>] 

GET http://<HOSTNAME>/api/entities/scroll/

Do you have some feedback for us?

If you have suggestions for improving this article,