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

# List Consumer Groups

> List consumer groups for the tenant with pagination.
Excludes internal/system consumer groups.



## OpenAPI

````yaml /openapi/openapi.json get /consumer-groups
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:
    get:
      tags:
        - Consumer Groups
      summary: List Consumer Groups
      description: |-
        List consumer groups for the tenant with pagination.
        Excludes internal/system consumer groups.
      operationId: listConsumerGroups
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number (1-indexed)
            default: 1
            title: Page
          description: Page number (1-indexed)
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 500
            minimum: 1
            description: Items per page
            default: 50
            title: Page Size
          description: Items per page
        - name: state
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by state. Comma-separated for multiple values (e.g.,
              'Dead,Empty'). Valid states: Stable, Empty, Dead,
              PreparingRebalance, CompletingRebalance, Unknown
            title: State
          description: >-
            Filter by state. Comma-separated for multiple values (e.g.,
            'Dead,Empty'). Valid states: Stable, Empty, Dead,
            PreparingRebalance, CompletingRebalance, Unknown
        - name: search
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Search by group ID (case-insensitive substring match)
            title: Search
          description: Search by group ID (case-insensitive substring match)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerGroupsPaginatedRes'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - FronteggHTTPAuthentication: []
components:
  schemas:
    ConsumerGroupsPaginatedRes:
      properties:
        page:
          type: integer
          title: Page
          description: Current page number
        page_size:
          type: integer
          title: Page Size
          description: Items per page
        total:
          type: integer
          title: Total
          description: Total number of consumer groups
        result:
          items:
            $ref: '#/components/schemas/ConsumerGroupListItem'
          type: array
          title: Result
          description: List of consumer groups
      additionalProperties: true
      type: object
      required:
        - page
        - page_size
        - total
        - result
      title: ConsumerGroupsPaginatedRes
      description: Paginated consumer groups list response.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConsumerGroupListItem:
      properties:
        group_id:
          type: string
          title: Group Id
          description: Consumer group ID
        state:
          type: string
          title: State
          description: Group state (e.g., Stable, Empty, Dead)
        member_count:
          type: integer
          title: Member Count
          description: Number of active members
          default: 0
      additionalProperties: true
      type: object
      required:
        - group_id
        - state
      title: ConsumerGroupListItem
      description: Basic consumer group information for list view.
    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

````