---
title: "List stores"
method: GET
path: "/v1/stores"
tags: ["stores"]
---

# List stores

`GET /v1/stores`

List all stores with optional search.

Args:
    pagination: The pagination options.
    q: Optional search query to filter vector stores.

Returns:
    StoreListResponse: The list of stores.

## Query parameters

- `limit` integer — Maximum number of items to return per page (1-100)
- `after` string, nullable — Cursor for forward pagination - get items after this position. Use last_cursor from previous response.
- `before` string, nullable — Cursor for backward pagination - get items before this position. Use first_cursor from previous response.
- `include_total` boolean — Whether to include total count in response (expensive operation)
- `q` string, nullable — Search query for fuzzy matching over name and description fields

## Response `200`

The list of stores

- StoreListResponse
  - `pagination` CursorPaginationResponse, required — Response model for cursor-based pagination.
    - `has_more` boolean, required — Contextual direction-aware flag: True if more items exist in the requested pagination direction. For 'after': more items after this page. For 'before': more items before this page.
    - `first_cursor` string, nullable, required — Cursor of the first item in this page. Use for backward pagination. None if page is empty.
    - `last_cursor` string, nullable, required — Cursor of the last item in this page. Use for forward pagination. None if page is empty.
    - `total` integer, nullable — Total number of items available across all pages. Only included when include_total=true was requested. Expensive operation - use sparingly.
  - `object` 'list' — The object type of the response
  - `data` Store[], required — The list of stores
    - `id` string, required — Unique identifier for the store
    - `name` string, required — Name of the store
    - `description` string, nullable — Detailed description of the store's purpose and contents
    - `is_public` boolean — Whether the store can be accessed by anyone with valid login credentials
    - `license` string, nullable — License for public stores
    - `metadata` unknown
    - `config` StoreConfig — Configuration for a store.
      - `contextualization` union — Contextualize files with metadata
        - boolean
        - ContextualizationConfig
          - `with_metadata` union — Include all metadata or specific fields in the contextualization. Supports dot notation for nested fields (e.g., 'author.name'). When True, all metadata is included (flattened). When a list, only specified fields are included.
            - boolean
            - string[]
          - `with_file_context` boolean — Use an LLM to generate a short context for each chunk with parsed text, OCR, transcription, or a summary that situates it within the document, improving retrieval accuracy. During sliced ingestion, chunks are situated within their current slice.
      - `save_content` boolean — Whether to save original content in the store. When False, only vectors are indexed without the original content (index-only mode). This is useful for data privacy. Note: Reranking is not supported when content is not saved.
    - `bucket_id` string, nullable — Customer bucket backing this store's storage; null = platform default
    - `file_counts` FileCounts — Tracks counts of files in different states within a store.
      - `pending` integer — Number of files waiting to be processed
      - `in_progress` integer — Number of files currently being processed
      - `cancelled` integer — Number of files whose processing was cancelled
      - `completed` integer — Number of successfully processed files
      - `failed` integer — Number of files that failed processing
      - `total` integer — Total number of files
    - `expires_after` ExpiresAfter — Represents an expiration policy for a store.
      - `anchor` 'last_active_at' — Anchor date for the expiration policy
      - `days` integer — Number of days after which the store expires
    - `status` 'expired' | 'in_progress' | 'completed' — Status of a store.
    - `created_at` string, date-time, required — Timestamp when the store was created
    - `updated_at` string, date-time, required — Timestamp when the store was last updated
    - `last_active_at` string, date-time, nullable — Timestamp when the store was last used
    - `usage_bytes` integer — Total storage usage in bytes
    - `usage_tokens` integer — Total storage usage in tokens
    - `expires_at` string, date-time, nullable — Optional expiration timestamp for the store
    - `object` 'store' — Type of the object

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/mixedbread/apis/mxbai-omni.md) · [All operations](https://skmtc.net/mixedbread/apis/mxbai-omni/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mixedbread/mxbai-omni/versions/2eece97b5ae5/schema)
