> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Namespace Snapshots

> List all snapshots for a namespace, newest first.



## OpenAPI

````yaml post /v1/namespaces/{namespace_identifier}/snapshots/list
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security:
  - BearerAuth: []
paths:
  /v1/namespaces/{namespace_identifier}/snapshots/list:
    post:
      tags:
        - Namespace Snapshots
      summary: List Namespace Snapshots
      description: List all snapshots for a namespace, newest first.
      operationId: list_snapshots_v1_namespaces__namespace_identifier__snapshots_list_post
      parameters:
        - name: namespace_identifier
          in: path
          required: true
          schema:
            type: string
            description: Namespace name or ID
            title: Namespace Identifier
          description: Namespace name or ID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSnapshotsRequest'
              description: Pagination parameters
              default:
                skip: 0
                limit: 20
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSnapshotsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ListSnapshotsRequest:
      properties:
        skip:
          type: integer
          minimum: 0
          title: Skip
          default: 0
        limit:
          type: integer
          maximum: 100
          minimum: 1
          title: Limit
          default: 20
      type: object
      title: ListSnapshotsRequest
    ListSnapshotsResponse:
      properties:
        results:
          items:
            $ref: '#/components/schemas/SnapshotModel'
          type: array
          title: Results
        total_count:
          type: integer
          title: Total Count
      type: object
      required:
        - results
        - total_count
      title: ListSnapshotsResponse
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    SnapshotModel:
      properties:
        snapshot_id:
          type: string
          title: Snapshot Id
        namespace_id:
          type: string
          title: Namespace Id
        namespace_name:
          type: string
          title: Namespace Name
        internal_id:
          type: string
          title: Internal Id
        snapshot_type:
          $ref: '#/components/schemas/SnapshotType'
        status:
          $ref: '#/components/schemas/SnapshotStatus'
          default: pending
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        completed_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Completed At
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
        schema_version:
          type: integer
          title: Schema Version
          default: 1
        s3_prefix:
          type: string
          title: S3 Prefix
          default: ''
        s3_objects_copied:
          type: boolean
          title: S3 Objects Copied
          default: false
        manifest:
          anyOf:
            - $ref: '#/components/schemas/SnapshotManifest'
            - type: 'null'
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        task_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Task Id
        include_vectors:
          type: boolean
          title: Include Vectors
          description: >-
            False for metadata-only daily snapshots whose vectors are covered by
            the shard representative's export.
          default: true
        vector_shard_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Shard Key
        last_restore:
          anyOf:
            - $ref: '#/components/schemas/RestoreReport'
            - type: 'null'
          description: >-
            Outcome of the most recent restore FROM this snapshot (what was
            restored vs skipped); null if never restored.
      type: object
      required:
        - namespace_id
        - namespace_name
        - internal_id
        - snapshot_type
      title: SnapshotModel
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    SnapshotType:
      type: string
      enum:
        - daily
        - pre_delete
        - manual
      title: SnapshotType
    SnapshotStatus:
      type: string
      enum:
        - pending
        - in_progress
        - completed
        - failed
        - expired
      title: SnapshotStatus
    SnapshotManifest:
      properties:
        snapshot_id:
          type: string
          title: Snapshot Id
        namespace_id:
          type: string
          title: Namespace Id
        namespace_name:
          type: string
          title: Namespace Name
        schema_version:
          type: integer
          title: Schema Version
          default: 1
        created_at:
          type: string
          format: date-time
          title: Created At
        snapshot_type:
          type: string
          title: Snapshot Type
        mongo_collections:
          additionalProperties:
            type: integer
          type: object
          title: Mongo Collections
          description: Map of collection name to document count
        vector_point_count:
          type: integer
          title: Vector Point Count
          default: 0
        s3_object_count:
          type: integer
          title: S3 Object Count
          default: 0
        s3_total_bytes:
          type: integer
          title: S3 Total Bytes
          default: 0
        s3_objects_copied:
          type: boolean
          title: S3 Objects Copied
          default: false
        include_vectors:
          type: boolean
          title: Include Vectors
          description: >-
            Whether this snapshot exported its own vector points. Daily sweeps
            coalesce the (full-dataset) vector export to ONE snapshot per
            physical shard; metadata-only snapshots set this False and rely on
            the shard representative's export (see vector_shard_key).
          default: true
        vector_shard_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Shard Key
          description: >-
            Physical shard this namespace's vectors live on; the shard
            representative's snapshot holds the actual vector export.
      type: object
      required:
        - snapshot_id
        - namespace_id
        - namespace_name
        - created_at
        - snapshot_type
      title: SnapshotManifest
    RestoreReport:
      properties:
        snapshot_id:
          type: string
          title: Snapshot Id
        target_namespace_id:
          type: string
          title: Target Namespace Id
        complete:
          type: boolean
          title: Complete
          description: >-
            True iff every non-empty collection AND the vectors were fully
            restored
        collections:
          items:
            $ref: '#/components/schemas/RestoreCollectionOutcome'
          type: array
          title: Collections
        vector_expected:
          type: integer
          title: Vector Expected
          default: 0
        vector_restored:
          type: integer
          title: Vector Restored
          default: 0
        vector_source:
          anyOf:
            - type: string
            - type: 'null'
          title: Vector Source
        vector_status:
          type: string
          title: Vector Status
          description: >-
            'restored', 'partial', 'failed', or 'none' (snapshot carried no
            vectors)
          default: none
        skipped_summary:
          items:
            type: string
          type: array
          title: Skipped Summary
          description: >-
            Human-readable list of everything not fully restored (empty when
            complete)
      type: object
      required:
        - snapshot_id
        - target_namespace_id
        - complete
      title: RestoreReport
      description: >-
        Outcome of a restore: exactly what was restored vs skipped.


        Restore is lenient (it warns + continues on a missing/corrupt dump), so
        a

        'completed' restore can be silently incomplete. This report records the

        per-collection and vector outcomes and a single ``complete`` flag so a

        partial restore is never mistaken for a clean one.
    RestoreCollectionOutcome:
      properties:
        collection:
          type: string
          title: Collection
        expected:
          type: integer
          title: Expected
        restored:
          type: integer
          title: Restored
        status:
          type: string
          title: Status
          description: '''restored'' (full), ''partial'' (restored < expected), or ''failed'''
        reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Reason
      type: object
      required:
        - collection
        - expected
        - restored
        - status
      title: RestoreCollectionOutcome
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Mixpeek API key, sent as `Authorization: Bearer mxp_sk_...`. Create one
        in Studio under Settings → API Keys, or with an admin key via `POST
        /v1/organizations/users/{user_email}/api-keys`. A missing header returns
        403; an invalid or revoked key returns 401.

````