Skip to main content
POST
/
v1
/
buckets
/
list
List Buckets
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "search": "<string>",
  "filters": {},
  "sort": {},
  "case_sensitive": false,
  "limit": 10,
  "offset": 0
}'
{
  "results": [
    {
      "bucket_id": "<string>",
      "bucket_name": "<string>",
      "description": "<string>",
      "bucket_schema": {
        "properties": {}
      },
      "metadata": {},
      "object_count": 123,
      "total_size_bytes": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_upload_at": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "is_locked": false,
      "batch_stats": {
        "total": 0,
        "active": 0,
        "completed": 0,
        "failed": 0
      },
      "storage_stats": {
        "avg_size_bytes": 0,
        "max_size_bytes": 0,
        "min_size_bytes": 0
      }
    }
  ],
  "total_count": 123,
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  },
  "stats": {
    "total_objects": 0,
    "total_size_bytes": 0,
    "avg_objects_per_bucket": 0,
    "avg_size_per_bucket": 0
  }
}

Authorizations

Authorization
string
header
required

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.

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.

Body

application/json

Request model for listing buckets.

Search term for wildcard search across all text fields

filters
object | null

Filters to apply to the bucket list

sort
object | null

Sort options for the bucket list

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

limit
integer
default:10

Number of results to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of results to skip

Required range: x >= 0

Response

Successful Response

Response model for listing buckets.

results
BucketResponse · object[]
required
total_count
integer
required

Total number of buckets matching the query

pagination
object
required

PaginationResponse.

stats
object | null

Aggregate statistics across all buckets in the result Aggregate statistics for a list of buckets.

I