---
title: "Scroll points"
method: POST
path: "/collections/{collection_name}/points/scroll"
tags: ["Scroll"]
---

# Scroll points

`POST /collections/{collection_name}/points/scroll`

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.

## Path parameters

- `collection_name` string, required

## Request body

- object
  - `limit` integer — Maximum number of points to return per page. Must be greater than 0. For example, `20` returns 20 points per page. Defaults to 100.
  - `offset` union — Cursor from a previous scroll response. Pass the `next_page_offset` value to fetch the next page. Omit or set to null for the first page.
    - integer
    - string
  - `filter` object — Optional filter conditions to narrow the scrolled results.
  - `with_payload` boolean — Whether to include payload metadata in the response.
  - `with_vector` boolean — Whether to include vector data in the response.

## Response `200`

Scroll results

- object
  - `usage` object
    - `hardware` object, nullable — Hardware resource counters for the operation, including CPU, payload I/O, payload index I/O, and vector I/O metrics.
  - `time` number, double — Time spent to process this request, in seconds.
  - `status` string — Operation status.
  - `result` object
    - `points` object[] — Array of point objects in this page.
      - `id` integer — The point's unique identifier.
      - `payload` object, nullable — Payload metadata, or null if `with_payload` is false.
      - `vector` number[], nullable — Vector data, or null if `with_vector` is false.
    - `next_page_offset` union — Cursor for the next page. Pass this as `offset` in the next request. Null when there are no more pages.
      - integer
      - string

## Other responses

- `4XX` — Error response

---

[API](https://skmtc.net/actiancorp/apis/actian-vectorai-db-search-api.md) · [All operations](https://skmtc.net/actiancorp/apis/actian-vectorai-db-search-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/actiancorp/actian-vectorai-db-search-api/versions/39108f79294c/schema)