Skip to main content
GET
List Cluster Groups

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

cluster_id
string
required

Cluster ID

Response

Successful Response

Response containing all groups for a cluster.

cluster_id
string
required
total_groups
integer
required
total_documents
integer
required
groups
ClusterGroup · object[]
required
run_id
string | null
member_counts_stale
boolean
default:false

True when member documents were deleted after this run completed, so member_count counts some documents that no longer exist. Re-run the cluster for current counts.