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
consistencyunionOptional
Define read consistency guarantees for the operation
Request
This endpoint expects an object.
shard_key
unionOptional
Specify in which shards to look for the points, if not specified - look in all shards
offset
unionOptional
Start ID to read points from.
limit
integerOptional
Page size. Default: 10
filter
unionOptional
Look only for points which satisfies this conditions. If not provided - all points.
with_payload
unionOptional
Select which payload to return with the response. Default is true.
with_vector
unionOptional
Options for specifying which vector to include
order_by
unionOptional
Order the records by a payload field.
Response
This endpoint returns an object
time
doubleOptional
Time spent to process this request
status
stringOptional
result
objectOptional
Result of the points read request
POST
1
curl -X POST http://localhost:6333/collections/collection_name/points/scroll \