Skip to main content
POST
/
v1
/
buckets
/
list
List Buckets
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/list \
  --header 'Content-Type: application/json' \
  --data '{
  "search": "<string>",
  "filters": {},
  "sort": "<string>"
}'
{
  "results": [
    {
      "bucket_id": "<string>",
      "bucket_name": "<string>",
      "description": "<string>",
      "bucket_schema": {
        "properties": {}
      },
      "metadata": {},
      "object_count": 123,
      "total_size_bytes": 123
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

Headers

Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request model for listing buckets.

Search term to filter buckets by name

filters
object | null

Filters to apply to the bucket list

sort
string | null

Sort order for the bucket list

Response

Successful Response

Response model for listing buckets.

results
BucketResponse · object[]
required
pagination
object
required

PaginationResponse.

I