List Consumer Groups

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

GET/consumer-groups

Authorization

AuthorizationBearer token · headerrequired

Query parameters

pageinteger

Page number (1-indexed)

min 1 · default: 1

page_sizeinteger

Items per page

min 1 · max 500 · default: 50

statestring

Filter by state. Comma-separated for multiple values (e.g., 'Dead,Empty'). Valid states: Stable, Empty, Dead, PreparingRebalance, CompletingRebalance, Unknown

searchstring

Search by group ID (case-insensitive substring match)

Responses

200

Successful Response

pageintegerrequired

Current page number

page_sizeintegerrequired

Items per page

totalintegerrequired

Total number of consumer groups

resultConsumerGroupListItem[]required

List of consumer groups

Show properties

Array of ConsumerGroupListItem

group_idstringrequired

Consumer group ID

statestringrequired

Group state (e.g., Stable, Empty, Dead)

member_countinteger

Number of active members

default: 0

422

Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET 'https://api.streamkap.com/consumer-groups' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.streamkap.com/consumer-groups", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.streamkap.com/consumer-groups",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "page": 0,
  "page_size": 0,
  "total": 0,
  "result": [
    {
      "group_id": "string",
      "state": "string",
      "member_count": 0
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}