Skip to main content
GET
/
consumer-groups
/
{group_id}
Get Consumer Group Detail
curl --request GET \
  --url https://api.streamkap.com/consumer-groups/{group_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.streamkap.com/consumer-groups/{group_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.streamkap.com/consumer-groups/{group_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.streamkap.com/consumer-groups/{group_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.streamkap.com/consumer-groups/{group_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.streamkap.com/consumer-groups/{group_id}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.streamkap.com/consumer-groups/{group_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "group_id": "<string>",
  "state": "<string>",
  "is_simple_consumer_group": true,
  "total_members": 123,
  "total_topics": 123,
  "page": 123,
  "page_size": 123,
  "partition_assignor": "<string>",
  "members": [
    {
      "member_id": "<string>",
      "client_id": "<string>",
      "host": "<string>"
    }
  ],
  "topics": [
    {
      "topic": "<string>",
      "partition": 123,
      "member_id": "<string>",
      "current_offset": 123,
      "log_end_offset": 123,
      "lag": 123
    }
  ],
  "total_lag": 0,
  "coordinator": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id
string
required

Query Parameters

page
integer
default:1

Page number for topics (1-indexed)

Required range: x >= 1
page_size
integer
default:50

Topics per page

Required range: 1 <= x <= 500
include_assignments
boolean
default:true

Include partition assignment details (set false for large groups)

topic_search
string | null

Search topics by name (case-insensitive substring match)

Response

Successful Response

Detailed consumer group information with paginated topics.

group_id
string
required

Consumer group ID

state
string
required

Group state

is_simple_consumer_group
boolean
required

Whether this is a simple (legacy) consumer group

total_members
integer
required

Total number of members

total_topics
integer
required

Total number of topic-partition assignments

page
integer
required

Current page number (for topics pagination)

page_size
integer
required

Topics per page (for pagination)

partition_assignor
string | null

Partition assignment strategy

members
ConsumerGroupMember · object[]

List of all members

topics
TopicPartitionAssignment · object[]

Paginated list of topic-partition assignments

total_lag
integer
default:0

Total lag across all partitions

coordinator
string | null

Group coordinator broker