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

# Get Kafka consumer group detail

> Retrieves a consumer group's members and per-topic offset lag. Results are cached for two minutes unless forceRefresh is true.



## OpenAPI

````yaml https://raw.githubusercontent.com/artie-labs/artie-api-spec/refs/heads/master/openapi.yaml get /kafka-clusters/{uuid}/consumer-groups/{groupID}
openapi: 3.1.0
info:
  description: External API endpoints for Artie
  title: Artie API
  version: v1.0.130
servers:
  - url: https://api.artie.com
security:
  - ApiKey: []
paths:
  /kafka-clusters/{uuid}/consumer-groups/{groupID}:
    get:
      tags:
        - Kafka Clusters
      summary: Get Kafka consumer group detail
      description: >-
        Retrieves a consumer group's members and per-topic offset lag. Results
        are cached for two minutes unless forceRefresh is true.
      operationId: kafka_consumer_group_detail
      parameters:
        - in: path
          name: groupID
          required: true
          schema:
            type: string
        - in: path
          name: uuid
          required: true
          schema:
            type: string
        - in: query
          name: forceRefresh
          schema:
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayloadsKafkaConsumerGroupDetail'
          description: OK
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
components:
  schemas:
    PayloadsKafkaConsumerGroupDetail:
      properties:
        consumerCount:
          type: integer
        groupID:
          type: string
        state:
          type: string
        topics:
          items:
            $ref: '#/components/schemas/PayloadsKafkaConsumerGroupTopic'
          type:
            - array
            - 'null'
      required:
        - groupID
        - consumerCount
        - state
        - topics
      type: object
    PayloadsKafkaConsumerGroupTopic:
      properties:
        partitions:
          items:
            $ref: '#/components/schemas/PayloadsKafkaConsumerGroupTopicPartition'
          type:
            - array
            - 'null'
        topic:
          type: string
      required:
        - topic
        - partitions
      type: object
    PayloadsKafkaConsumerGroupTopicPartition:
      properties:
        currentOffset:
          format: int64
          type: integer
        lag:
          format: int64
          type: integer
        logEndOffset:
          format: int64
          type: integer
        partition:
          type: integer
      required:
        - partition
        - currentOffset
        - logEndOffset
        - lag
      type: object
  securitySchemes:
    ApiKey:
      description: API key passed as a Bearer token in the Authorization header.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.