Skip to main content
POST
/
v1
/
collections
/
{collection_identifier}
/
documents
/
list
List documents.
curl --request POST \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '{
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "search": "<string>",
  "return_url": true,
  "return_vectors": true
}'
{
  "results": [
    {
      "collection_id": "col_articles",
      "description": "Text document without artifacts (return_url=false)",
      "document_blobs": [],
      "document_id": "doc_f8966ff29c18e20c6b45e053",
      "internal_metadata": {
        "ingestion_status": "COMPLETED"
      },
      "lineage_chain": [
        {
          "collection_id": "col_articles",
          "feature_extractor_id": "text_extractor_v1",
          "timestamp": "2025-10-31T10:00:00Z"
        }
      ],
      "lineage_path": "bkt_content/col_articles",
      "metadata": {
        "author": "Dr. Smith",
        "title": "AI in Healthcare"
      },
      "presigned_urls": [],
      "root_bucket_id": "bkt_content",
      "root_object_id": "obj_article_001",
      "source_blobs": [
        {
          "blob_id": "blob_text_001",
          "blob_property": "content",
          "blob_type": "text"
        }
      ],
      "source_object_id": "obj_article_001",
      "source_type": "bucket"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  },
  "stats": {
    "total_documents": 0,
    "avg_blobs_per_document": 0,
    "documents_with_vectors": 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
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

collection_identifier
string
required

The ID of the collection to list documents from.

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request model for listing documents.

filters
object | null

Filters to apply. Represents a logical operation (AND, OR, NOT) on filter conditions.

Allows nesting with a defined depth limit.

Also supports shorthand syntax where field names can be passed directly as key-value pairs for equality filtering (e.g., {"metadata.title": "value"}).

sort
object | null

Sort options. Specifies how to sort query results.

Attributes: field: Field to sort by direction: Sort direction (ascending or descending)

Search term.

return_url
boolean | null
default:false

Whether to return presigned URLs for object keys.

return_vectors
boolean | null
default:false

Whether to return vector embeddings in the document results.

Response

Successful Response

Response model for listing documents.

results
DocumentResponse · object[]
required
pagination
object
required

PaginationResponse.

stats
object | null

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