Skip to main content
GET
/
consumer-groups
List Consumer Groups
curl --request GET \
  --url https://api.streamkap.com/consumer-groups \
  --header 'Authorization: Bearer <token>'
{
  "page": 123,
  "page_size": 123,
  "total": 123,
  "result": [
    {
      "group_id": "<string>",
      "state": "<string>",
      "member_count": 0
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
page_size
integer
default:50

Items per page

Required range: 1 <= x <= 500
​
state
string | null

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

​
search
string | null

Search by group ID (case-insensitive substring match)

Response

Successful Response

Paginated consumer groups list response.

​
page
integer
required

Current page number

​
page_size
integer
required

Items per page

​
total
integer
required

Total number of consumer groups

​
result
ConsumerGroupListItem · object[]
required

List of consumer groups