Query points, grouped by a given payload field

Changed on Oct 22, 2026

Universally query points, grouped by a given payload field

post/collections/{collection_name}/points/query/groups

Request

Base URL
http://localhost:6333
Auth
- API key in header api-key
- or HTTP bearer
- or none
TypeScript
https://skmtc.dev/qdrant/apis/qdrant-api/docs/collections/:collection_name/points/query/groups/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

collection_namestring required

Name of the collection to query

Query parameters

integer

'majority' | 'quorum' | 'all'

majority - send N/2+1 random request and return points, which present on all of them
quorum - send requests to all nodes and return points which present on majority of nodes
all - send requests to all nodes and return points which present on all nodes

Define read consistency guarantees for the operation

timeoutinteger

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

Request body

usingstring nullable

Define which vector name to use for querying. If missing, the default vector is used. For a text query, the payload field whose text index to search.

score_thresholdnumber float nullable

Return points with scores better than this threshold.

group_bystring required

Payload field to group by, must be a string or number field. If the field contains more than 1 value, all values will be used for grouping. One point can be in multiple groups.

group_sizeinteger nullable

Maximum amount of points to return per group. Default is 3.

limitinteger nullable

Maximum amount of groups to return. Default is 10.

Response

successful operation

timenumber float

Time spent to process this request

statusstring

Example response

{
  "time": 0.002,
  "status": "ok",
  "result": {
    "groups": [
      {
        "hits": [
          {
            "id": 42,
            "version": 3,
            "score": 0.75,
            "payload": {
              "city": "London",
              "color": "green"
            },
            "vector": [
              0.875,
              0.140625,
              0.897599995136261
            ],
            "shard_key": "region_1",
            "order_value": 42
          }
        ],
        "lookup": {
          "id": 42,
          "payload": {
            "city": "London",
            "color": "green"
          },
          "vector": [
            0.875,
            0.140625,
            0.897599995136261
          ],
          "shard_key": "region_1",
          "order_value": 42
        }
      }
    ]
  }
}

Changes

Oct 22, 2026c93be9a86fe5 Revision changes
- info
  added to the //////////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ////////////////////////////// request property anyOf list
- info
  added to the //////////////////////////// request property anyOf list
- info
  added to the ////////////////////////// request property anyOf list
- info
  added to the //////////////////////////// request property anyOf list
- info
  added to the ////////////////////////// request property anyOf list
- info
  added to the //////////////////////////// request property anyOf list
- info
  added to the ////////////////////////// request property anyOf list
- info
  added to the ///////////////////////// request property anyOf list
- info
  added to the /////////////////////// request property anyOf list
- info
  added to the ///////////////////// request property anyOf list
- info
  added to the /////////////////////// request property anyOf list
- info
  added to the ///////////////////// request property anyOf list
- info
  added to the /////////////////////// request property anyOf list
- info
  added to the ///////////////////// request property anyOf list
- info
  added to the /////////////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the /////////////////////// request property anyOf list
- info
  added to the ///////////////////// request property anyOf list
- info
  added to the /////////////////// request property anyOf list
- info
  added to the ///////////////////// request property anyOf list
- info
  added to the /////////////////// request property anyOf list
- info
  added to the ///////////////////// request property anyOf list
- info
  added to the /////////////////// request property anyOf list
- info
  added to the ///////////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////// request property anyOf list
- info
  added to the /////////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////// request property anyOf list
- info
  added to the ///////////////////////////// request property anyOf list
- info
  added to the ////////////////////////// request property anyOf list
- info
  added to the ///////////// request property anyOf list
- info
  added to the /////////// request property anyOf list
- info
  added to the //////// request property anyOf list
- info
  added the new code enum value to the request property /////////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////
- info
  added the new code enum value to the request property ///////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////
- info
  added the new code enum value to the request property /////////////////////////////
- info
  added the new code enum value to the request property //////////////////////////////
- info
  added the new code enum value to the request property ////////////////////////////
- info
  added the new code enum value to the request property //////////////////////
Sep 6, 2026b251b66ce30a Revision changes
- info
  added to the ////////////////// request property anyOf list
- info
  added to the //////////////// request property anyOf list
- info
  added to the ///////////// request property anyOf list

Operation history (11 revisions)