Scroll points — Qdrant

Returns all points in a page-by-page manner. By default, all resulting points are sorted by {id}. To query the next page specify the last {id} in the offset field. Additionally, you can specify filters and sorting options.

Path parameters

collection_namestringRequired

Name of the collection to retrieve from

Query parameters

consistencyinteger or enumOptional

Define read consistency guarantees for the operation

timeoutintegerOptional

If set, overrides global timeout for this request. Unit is seconds.

Request

This endpoint expects an object.

shard_keystring or integer or list of strings or integers or anyOptional

Specify in which shards to look for the points, if not specified - look in all shards

offsetinteger or string or anyOptional

Start ID to read points from.

limitintegerOptional

Page size. Default: 10

filterobject or anyOptional

Look only for points which satisfies this conditions. If not provided - all points.

with_payloadboolean or list of strings or object or anyOptional

Select which payload to return with the response. Default is true.

with_vectorboolean or list of stringsOptional

Options for specifying which vector to include

order_bystring or object or anyOptional

Order the records by a payload field.

Response

This endpoint returns an object.

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Result of the points read request

1	curl -X POST \
2	'http://localhost:6333/collections/collection_name/points/scroll' \
3	--header 'api-key: <api-key-value>' \
4	--header 'Content-Type: application/json' \
5	--data-raw '{
6	"with_payload": [
7	"city",
8	"color"
9	],
10	"filter": {
11	"must": [
12	{
13	"key": "color",
14	"match": {
15	"value": "red"
16	}
17	}
18	]
19	},
20	"limit": 2,
21	"with_vector": false
22	}'

1	{
2	"time": 0.002,
3	"status": "ok",
4	"result": {
5	"points": [
6	{
7	"id": 40,
8	"payload": {
9	"city": "London",
10	"color": "green"
11	},
12	"vector": [
13	0.875,
14	0.140625,
15	0.897599995136261
16	],
17	"shard_key": "region_1",
18	"order_value": 42
19	},
20	{
21	"id": 41,
22	"payload": {
23	"city": "Paris",
24	"color": "red"
25	},
26	"vector": [
27	0.75,
28	0.640625,
29	0.8945000171661377
30	],
31	"shard_key": "region_1",
32	"order_value": 42
33	}
34	],
35	"next_page_offset": 42
36	}
37	}