Get Consumer Group Detail

Get detailed information about a specific consumer group.

Returns all members and paginated topic-partition assignments with member attribution. Use include_assignments=false for large consumer groups to skip assignment details.

Pagination applies to topics, not members (all members are returned).

Security: Consumer groups are tenant-isolated via k8s_namespace. Each tenant has their own Kafka cluster, so consumer groups from other tenants are not accessible.

GET/consumer-groups/{group_id}

Authorization

AuthorizationBearer token · headerrequired

Path parameters

group_idstringrequired

Query parameters

pageinteger

Page number for topics (1-indexed)

min 1 · default: 1

page_sizeinteger

Topics per page

min 1 · max 500 · default: 50

include_assignmentsboolean

Include partition assignment details (set false for large groups)

default: true

topic_searchstring | any

Search topics by name (case-insensitive substring match)

Responses

200

Successful Response

group_idstringrequired

Consumer group ID

statestringrequired

Group state

is_simple_consumer_groupbooleanrequired

Whether this is a simple (legacy) consumer group

partition_assignorstring | any

Partition assignment strategy

Show properties

Any of:

string

string

any

any

membersConsumerGroupMember[]

List of all members

Show properties

Array of ConsumerGroupMember

member_idstringrequired

Unique member ID

client_idstringrequired

Client application ID

hoststringrequired

Consumer host

total_membersintegerrequired

Total number of members

topicsTopicPartitionAssignment[]

Paginated list of topic-partition assignments

Show properties

Array of TopicPartitionAssignment

topicstringrequired

partitionintegerrequired

member_idstringrequired

Member ID that owns this partition

current_offsetinteger | any

Current committed offset

Show properties

Any of:

integer

integer

any

any

log_end_offsetinteger | any

Latest offset in partition

Show properties

Any of:

integer

integer

any

any

laginteger | any

Consumer lag (log_end_offset - current_offset)

Show properties

Any of:

integer

integer

any

any

total_topicsintegerrequired

Total number of topic-partition assignments

pageintegerrequired

Current page number (for topics pagination)

page_sizeintegerrequired

Topics per page (for pagination)

total_laginteger

Total lag across all partitions

default: 0

coordinatorstring | any

Group coordinator broker

Show properties

Any of:

string

string

any

any

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "https://api.streamkap.com/consumer-groups/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.streamkap.com/consumer-groups/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/consumer-groups/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "group_id": "string",
  "state": "string",
  "is_simple_consumer_group": true,
  "partition_assignor": "string",
  "members": [
    {
      "member_id": "string",
      "client_id": "string",
      "host": "string"
    }
  ],
  "total_members": 0,
  "topics": [
    {
      "topic": "string",
      "partition": 0,
      "member_id": "string",
      "current_offset": 0,
      "log_end_offset": 0,
      "lag": 0
    }
  ],
  "total_topics": 0,
  "page": 0,
  "page_size": 0,
  "total_lag": 0,
  "coordinator": "string"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}