---
title: "POST /public/v1/clusters/{clusterName}/consumergroups"
method: POST
path: "/public/v1/clusters/{clusterName}/consumergroups"
tags: ["consumergroup"]
---

# POST /public/v1/clusters/{clusterName}/consumergroups

`POST /public/v1/clusters/{clusterName}/consumergroups`

## Request

- Base URL: `https://developers.conduktor.io` (the document declares no server; this is the origin it was published from)
- URL: `https://developers.conduktor.io/public/v1/clusters/{clusterName}/consumergroups`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/conduktor/apis/conduktor-console-api/docs/public/v1/clusters/:clusterName/consumergroups/post.ts> (a function with typed inputs; its response is checked against the schema)

List consumer group

## Path parameters

- `clusterName` string, required

## Request body

- ConsumerGroupRequest
  - `page` integer, required: Page number, starting from 1
  - `itemsPerPage` integer, required
  - `filter` ConsumerGroupFilter[]
    - union
      - OnConsumerGroupName
        - `contains` string, required
        - `type` 'OnConsumerGroupName', required
      - OnGroupType
        - `oneOf` GroupType[]
        - `type` 'OnGroupType', required
      - OnLabels
        - `key` string, required
        - `values` string[]
        - `type` 'OnLabels', required
      - OnState
        - `oneOf` ConsumerGroupState[]
        - `type` 'OnState', required
  - `sort` 'ByName' | 'ByState' | 'ByOverallLag' | 'ByMaxLagTimeInSeconds' | 'ByMembers' | 'ByGroupType' | 'ByTopicCount', required
  - `descSort` boolean

## Response `200`

- PageConsumerGroupResponse
  - `data` ConsumerGroupResponse[]
    - union
      - IndexedConsumerGroup
        - `name` string, required
        - `state` 'Unknown' | 'PreparingRebalance' | 'CompletingRebalance' | 'Stable' | 'Dead' | 'Empty' | 'Assigning' | 'Reconciling', required
        - `members` integer, required
        - `overallLag` integer
        - `topics` string[]
        - `maxLagTimeInSeconds` integer
        - `labels` MapLabelKeyString, required
        - `groupType` 'Unknown' | 'Classic' | 'Consumer' | 'Share', required
        - `type` 'IndexedConsumerGroup', required
      - NotIndexedConsumerGroup
        - `name` string, required
        - `type` 'NotIndexedConsumerGroup', required
  - `page` integer, required
  - `totalPages` integer, required
  - `perPage` integer, required
  - `totalElements` integer, required

## Other responses

- `400`: The request is not valid
- `401`: The user is not authenticated
- `403`: The user doesn't have the required permission(s) "kafka.groups.describe" to do this operation
- `404`: No cluster with this technical id exist
- `500`: An unexpected error occurred in the server

---

[API](https://skmtc.dev/conduktor/apis/conduktor-console-api.md) - [All operations](https://skmtc.dev/conduktor/apis/conduktor-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conduktor/apis/conduktor-console-api/revisions/24750c294805?raw)