v3

latestOpenAPI 3.0.3raw.githubusercontent.com2026-04-274135.4 KB

Scroll

Scroll points

Paginate through all points in a collection. The response includes a next_page_offset cursor that you pass as offset in subsequent requests to retrieve the next page. Useful for exporting data, iterating large datasets, or processing points in batches.

post/collections/{collection_name}/points/scroll

Path parameters

collection_namestring required

The name of the collection to scroll through.

Request body

limitinteger

Maximum number of points to return per page. Must be greater than 0. For example, 20 returns 20 points per page. Defaults to 100.

filterobject

Optional filter conditions to narrow the scrolled results.

with_payloadboolean

Whether to include payload metadata in the response.

with_vectorboolean

Whether to include vector data in the response.

Example request

{
  "limit": 10,
  "with_payload": true
}

Response

Scroll results

timenumber double

Time spent to process this request, in seconds.

statusstring

Operation status.

Example response

{
  "time": 0.000129652,
  "status": "ok",
  "result": {
    "points": [
      {
        "id": 1,
        "payload": {
          "category": "A",
          "value": 10
        }
      }
    ]
  }
}