Skip to main content
POST
/
v1
/
buckets
/
{bucket_identifier}
/
objects
/
list
List Objects
curl --request POST \
  --url https://api.mixpeek.com/v1/buckets/{bucket_identifier}/objects/list \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <x-namespace>'
{
  "pagination": {
    "has_more": false,
    "limit": 10,
    "skip": 0
  },
  "results": [
    {
      "blobs": [],
      "bucket_id": "bkt_9xy8z7",
      "created_at": "2024-10-21T10:30:00Z",
      "key_prefix": "/contract-2024",
      "metadata": {
        "category": "contracts",
        "year": 2024
      },
      "object_id": "obj_123abc456def",
      "status": "DRAFT",
      "updated_at": "2024-10-21T10:30:00Z"
    }
  ]
}

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
required

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 sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
X-Namespace
string
required

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"

Path Parameters

​
bucket_identifier
string
required

The unique identifier of the bucket.

Query Parameters

​
limit
integer | null
​
offset
integer | null

Response

Successful Response

Response model for listing objects in a bucket.

​
results
ObjectResponse · object[]
required

List of objects matching the query

​
pagination
object
required

Pagination information

​
stats
object | null

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