> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamkap.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi/openapi.json get /consumer-groups/{group_id}
openapi: 3.1.0
info:
  title: Streamkap REST API
  description: >-
    The Streamkap REST API allows you to programmatically manage your CDC
    pipelines, sources, destinations, transforms, and more.


    Authenticate using a bearer token obtained from the [Access
    Token](/api-reference/auth/access-token) endpoint with your API client
    credentials.
  contact:
    name: Streamkap Support
    url: https://streamkap.com/
    email: support@streamkap.com
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api.streamkap.com
    description: Production
security: []
tags:
  - name: Alerts
    description: Manage alert subscribers, preferences, and notification credentials.
  - name: Authentication
    description: Obtain and refresh access tokens, manage client credentials and roles.
  - name: Billing
    description: Retrieve usage metrics, summaries, and export billing data.
  - name: Consumer Groups
    description: List, inspect, and reset Kafka consumer group offsets.
  - name: Dashboard
    description: Retrieve organisation-level statistics and overview data.
  - name: Destinations
    description: Create, configure, and manage data destinations and their lifecycle.
  - name: Kafka Access
    description: Manage Kafka users and their access permissions.
  - name: Logs
    description: Query and summarise system logs.
  - name: Pipelines
    description: Create, configure, and manage CDC pipelines and their lifecycle.
  - name: Project Keys
    description: Manage project keys that bundle API credentials and optional Kafka access.
  - name: Schema Registry
    description: Browse schema subjects, versions, and retrieve schema definitions.
  - name: Services
    description: View and switch service metadata.
  - name: Sources
    description: >-
      Create, configure, and manage data sources, snapshots, and their
      lifecycle.
  - name: Tags
    description: Create, update, and manage resource tags for organisation.
  - name: Topics
    description: Browse topic details, statistics, configurations, metrics, and messages.
  - name: Transforms
    description: >-
      Create, deploy, and manage data transforms, unit tests, and implementation
      details.
paths:
  /consumer-groups/{group_id}:
    get:
      tags:
        - Consumer Groups
      summary: Get Consumer Group Detail
      description: >-
        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.
      operationId: getConsumerGroup
      parameters:
        - name: group_id
          in: path
          required: true
          schema:
            type: string
            title: Group Id
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number for topics (1-indexed)
            default: 1
            title: Page
          description: Page number for topics (1-indexed)
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Topics per page
            default: 50
            title: Page Size
          description: Topics per page
        - name: include_assignments
          in: query
          required: false
          schema:
            type: boolean
            description: Include partition assignment details (set false for large groups)
            default: true
            title: Include Assignments
          description: Include partition assignment details (set false for large groups)
        - name: topic_search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search topics by name (case-insensitive substring match)
            title: Topic Search
          description: Search topics by name (case-insensitive substring match)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerGroupDetail'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    ConsumerGroupDetail:
      properties:
        group_id:
          type: string
          title: Group Id
          description: Consumer group ID
        state:
          type: string
          title: State
          description: Group state
        is_simple_consumer_group:
          type: boolean
          title: Is Simple Consumer Group
          description: Whether this is a simple (legacy) consumer group
        partition_assignor:
          anyOf:
            - type: string
            - type: 'null'
          title: Partition Assignor
          description: Partition assignment strategy
        members:
          items:
            $ref: '#/components/schemas/ConsumerGroupMember'
          type: array
          title: Members
          description: List of all members
        total_members:
          type: integer
          title: Total Members
          description: Total number of members
        topics:
          items:
            $ref: '#/components/schemas/TopicPartitionAssignment'
          type: array
          title: Topics
          description: Paginated list of topic-partition assignments
        total_topics:
          type: integer
          title: Total Topics
          description: Total number of topic-partition assignments
        page:
          type: integer
          title: Page
          description: Current page number (for topics pagination)
        page_size:
          type: integer
          title: Page Size
          description: Topics per page (for pagination)
        total_lag:
          type: integer
          title: Total Lag
          description: Total lag across all partitions
          default: 0
        coordinator:
          anyOf:
            - type: string
            - type: 'null'
          title: Coordinator
          description: Group coordinator broker
      additionalProperties: true
      type: object
      required:
        - group_id
        - state
        - is_simple_consumer_group
        - total_members
        - total_topics
        - page
        - page_size
      title: ConsumerGroupDetail
      description: Detailed consumer group information with paginated topics.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConsumerGroupMember:
      properties:
        member_id:
          type: string
          title: Member Id
          description: Unique member ID
        client_id:
          type: string
          title: Client Id
          description: Client application ID
        host:
          type: string
          title: Host
          description: Consumer host
      additionalProperties: true
      type: object
      required:
        - member_id
        - client_id
        - host
      title: ConsumerGroupMember
      description: Consumer group member information.
    TopicPartitionAssignment:
      properties:
        topic:
          type: string
          title: Topic
        partition:
          type: integer
          title: Partition
        member_id:
          type: string
          title: Member Id
          description: Member ID that owns this partition
        current_offset:
          anyOf:
            - type: integer
            - type: 'null'
          title: Current Offset
          description: Current committed offset
        log_end_offset:
          anyOf:
            - type: integer
            - type: 'null'
          title: Log End Offset
          description: Latest offset in partition
        lag:
          anyOf:
            - type: integer
            - type: 'null'
          title: Lag
          description: Consumer lag (log_end_offset - current_offset)
      additionalProperties: true
      type: object
      required:
        - topic
        - partition
        - member_id
      title: TopicPartitionAssignment
      description: Topic partition assignment for a consumer.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    FronteggHTTPAuthentication:
      type: http
      scheme: bearer

````