---
title: "List Consumer Groups"
method: GET
path: "/clusters/{cluster_id}/consumer-groups"
tags: ["Consumer Group (v3)"]
---

# List Consumer Groups

`GET /clusters/{cluster_id}/consumer-groups`

[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)

Returns the list of consumer groups that belong to the specified
Kafka cluster.

## Response `200`

The list of consumer groups.

- ConsumerGroupDataList
  - `kind` string, required
  - `metadata` ResourceCollectionMetadata, required
    - `self` string, required
    - `next` string, nullable
  - `data` ConsumerGroupData[], required
    - `kind` string, required
    - `metadata` ResourceMetadata, required
      - `self` string, required
      - `resource_name` string, nullable
    - `cluster_id` string, required
    - `consumer_group_id` string, required
    - `is_simple` boolean, required
    - `partition_assignor` string, required
    - `state` string, required
    - `coordinator` Relationship, required
      - `related` string, required
    - `consumer` Relationship
      - `related` string, required
    - `lag_summary` Relationship, required
      - `related` string, required

## Other responses

- `400` — Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure. Usually serves application/json content, although in some cases simple text/plain content can be returned.
- `401` — Indicates a client authentication error. Kafka authentication failures will contain error code 40101 in the response body.
- `429` — Indicates that a rate limit threshold has been reached, and the client should retry again later.
- `5XX` — A server-side problem that might not be addressable from the client side. Retriable Kafka errors will contain error code 50003 in the response body.

## Changes

- **2022-03-22** (v3) `7500cc59fcff` — 12 info
  - api operation id `listKafkaV3ConsumerGroups` was added
  - api tag `Consumer Group (v3)` added
  - api tag `Consumer Group` removed
  - added the non-success response with the status `400`
  - …8 more
- **2022-03-22** (v3) `0b87d328c664` — 6 warning, 6 info
  - added the new `COMPLETING_REBALANCE` enum value to the `allOf[subschema #2]/data/items/allOf[subschema #2]/state` response property for the response status `200`
  - added the new `DEAD` enum value to the `allOf[subschema #2]/data/items/allOf[subschema #2]/state` response property for the response status `200`
  - added the new `EMPTY` enum value to the `allOf[subschema #2]/data/items/allOf[subschema #2]/state` response property for the response status `200`
  - added the new `PREPARING_REBALANCE` enum value to the `allOf[subschema #2]/data/items/allOf[subschema #2]/state` response property for the response status `200`
  - …8 more
- **2022-01-18** (v3) `242a6e383b71` — 12 info
  - api operation id `listKafkaV3ConsumerGroups` was added
  - api tag `Consumer Group (v3)` added
  - api tag `Consumer Group` removed
  - added the non-success response with the status `400`
  - …8 more
- …earlier changes not shown

[Full history](https://skmtc.dev/confluentinc/apis/rest-admin-api/changes/clusters/:cluster_id/consumer-groups/get.md)

---

[API](https://skmtc.dev/confluentinc/apis/rest-admin-api.md) · [All operations](https://skmtc.dev/confluentinc/apis/rest-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/confluentinc/rest-admin-api/revisions/1539b3a4a2df/schema)