v1

OpenAPI 3.1.0Proprietary2026-07-13197242444.9 KB
Consumer Groups

List Consumer Groups

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

get/consumer-groups

Query parameters

pageinteger

Page number (1-indexed)

Page number (1-indexed)

page_sizeinteger

Items per page

Items per page

statestring nullable

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

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

searchstring nullable

Search by group ID (case-insensitive substring match)

Search by group ID (case-insensitive substring match)

Response

Successful Response

pageinteger required

Current page number

page_sizeinteger required

Items per page

totalinteger required

Total number of consumer groups