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": {},
  "case_sensitive": false,
  "limit": 10,
  "offset": 0
}
'
{
  "results": [
    {
      "bucket_name": "<string>",
      "object_count": 123,
      "total_size_bytes": 123,
      "bucket_id": "<string>",
      "description": "<string>",
      "bucket_schema": {
        "properties": {}
      },
      "unique_key": {
        "default_policy": "upsert",
        "description": "Single field, upsert by default (idempotent video ingestion)",
        "fields": [
          "video_id"
        ]
      },
      "metadata": {},
      "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": {
        "total_size_bytes": 0,
        "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>",
    "next_cursor": "<string>"
  },
  "stats": {
    "total_objects": 0,
    "total_size_bytes": 0,
    "avg_objects_per_bucket": 0,
    "avg_size_per_bucket": 0
  }
}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Body

application/json

Request model for listing buckets.

​
search
string | null

Search term for wildcard search across bucket_id, bucket_name, description, and other text fields

​
filters
Filters · object

Filters to apply to the bucket list. Supports filtering by bucket_id or bucket_name.

​
sort
Sort · object

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
PaginationResponse · object
required

PaginationResponse.

Supports both offset-based and cursor-based pagination:

  • Offset-based: Use page/page_size for navigation
  • Cursor-based: Use next_cursor for efficient deep pagination
​
stats
BucketListStats · object

Aggregate statistics across all buckets in the result