Skip to main content
GET
Get Consumer Group Detail

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