Skip to main content
GET
List Clusters (GET)

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 header returns 403; an invalid or revoked key returns 401.

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.

Query Parameters

search
string | null

Search query string

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
next_cursor
string | null
after
string | null
include_total
boolean
default:false

Response

Successful Response

Response model for listing clusters.

results
ClusterMetadata · object[]
required

List of cluster metadata

pagination
PaginationResponse · object
required

Pagination information

total_count
integer
required

Total number of clusters matching the query

stats
ClusterListStats · object | null

Aggregate statistics across all clusters in the result