Consumer Groups

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}

Request

Base URL
https://api.streamkap.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/streamkap/apis/streamkap-rest-api/docs/consumer-groups/:group_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

group_idstring required

Query parameters

pageinteger

Page number for topics (1-indexed)

page_sizeinteger

Topics per page

include_assignmentsboolean

Include partition assignment details (set false for large groups)

topic_searchstring nullable

Search topics by name (case-insensitive substring match)

Response

Successful Response

group_idstring required

Consumer group ID

statestring required

Group state

is_simple_consumer_groupboolean required

Whether this is a simple (legacy) consumer group

partition_assignorstring nullable

Partition assignment strategy

total_membersinteger required

Total number of members

total_topicsinteger required

Total number of topic-partition assignments

pageinteger required

Current page number (for topics pagination)

page_sizeinteger required

Topics per page (for pagination)

total_laginteger

Total lag across all partitions

coordinatorstring nullable

Group coordinator broker

Changes

No recorded changes to this operation across all 10 revisions of this API.