Confluent | the Data Streaming Platform

Confluent | the Data Streaming Platform Consumer Group (v3) API

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

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /kafka/v3/clusters/{cluster_id}/consumer-groups List consumer groups on a cluster · List Consumer Groups #
Ask an LLM
“Which consumer groups are reading from my Kafka cluster?”
“Can I see every consumer group registered on a Confluent Cloud cluster?”
Tell an agent
List consumer groups on cluster {cluster_id}.
Show all consumer groups for Kafka cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id} Get a consumer group · Get Consumer Group #
Ask an LLM
“What state is a particular consumer group in?”
“Who is the coordinator and which assignor does my consumer group use?”
Tell an agent
Get consumer group {consumer_group_id} on cluster {cluster_id}.
Show details for consumer group {consumer_group_id} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers List consumers in a group · List Consumers #
Ask an LLM
“Which consumers are members of a consumer group right now?”
“How many consumer instances are in my group?”
Tell an agent
List consumers in group {consumer_group_id} on cluster {cluster_id}.
Show the member consumers of {consumer_group_id} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary Summarize a consumer group's lag · Get Consumer Group Lag Summary #
Ask an LLM
“How far behind is my consumer group overall?”
“What is the maximum and total lag for a consumer group?”
Tell an agent
Get the lag summary for consumer group {consumer_group_id} on cluster {cluster_id}.
Show max and total lag of group {consumer_group_id} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags List per-partition lag for a group · List Consumer Lags #
Ask an LLM
“Which partitions is my consumer group lagging on?”
“Can I break a consumer group's lag down by consumer and partition?”
Tell an agent
List consumer lags for group {consumer_group_id} on cluster {cluster_id}.
Break down lag per partition for consumer group {consumer_group_id} in cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id} Get lag on one partition · Get Consumer Lag #
Ask an LLM
“How far behind is my consumer group on one specific topic partition?”
“What are the current and end offsets for a group on a single partition?”
Tell an agent
Get lag of group {consumer_group_id} on topic {topic_name} partition {partition_id} in cluster {cluster_id}.
Check partition {partition_id} of {topic_name} lag for consumer group {consumer_group_id} on cluster {cluster_id}.
GET /kafka/v3/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id} Get one consumer in a group · Get Consumer #
Ask an LLM
“What client ID and host is a specific consumer running on?”
“Can I look up one consumer instance within a consumer group?”
Tell an agent
Get consumer {consumer_id} in group {consumer_group_id} on cluster {cluster_id}.
Show details of consumer {consumer_id} from group {consumer_group_id} in cluster {cluster_id}.

Documentation

📖
Documentation
https://docs.confluent.io/cloud/current/api.html
📖
APIReference
https://docs.confluent.io/cloud/current/api.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-consumer-group-v3-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/mcp/confluent-the-data-streaming-platform-tool-crosswalk.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/data-model/confluent-the-data-streaming-platform-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/confluent-the-data-streaming-platform:confluent-the-data-streaming-platform-consumer-group-v3-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

confluent-the-data-streaming-platform-consumer-group-v3-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Confluent Cloud Consumer Group (v3) API
  version: ''
  x-api-id: 46234552-5833-42eb-ba0f-883ad3f70d2b
  x-audience: external-public
  x-logo:
    url: https://assets.confluent.io/m/1661ef5e4ff82d3d/
  description: '# Introduction


    Note


    This documents the collection of Confluent Cloud APIs.'
servers:
- url: https://api.confluent.cloud
  description: Confluent Cloud API
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/confluent-the-data-streaming-platform/refs/heads/main/openapi/confluent-the-data-streaming-platform-consumer-group-v3-api-openapi.yml