Scroll documents

In the first request, the X-VTEX-MD-TOKEN token will be returned in the header. This token must be passed to the next request in the query string _token parameter. The token has a timeout of 10 minutes, which refreshes after each request.

After the token is obtained it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.

Request examples

First request:

/dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName

Retrieve the token in the header X-VTEX-MD-TOKEN from the first request's response and use it to make the next requests.

Subsequent requests:

/dataentities/CL/scroll?_token={tokenValueExample}
Language
Authentication
URL
Click Try It! to start a request and see the response here!