Skip to main content
GET
List Buckets

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

Free-text search over bucket names.

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 buckets.

results
BucketResponse · object[]
required
total_count
integer
required

Total number of buckets matching the query

pagination
PaginationResponse · object
required

PaginationResponse.

Cursor-based pagination response:

  • Use next_cursor for navigation
  • Total count fields only populated when include_total=true
stats
BucketListStats · object | null

Aggregate statistics across all buckets in the result