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

# List matches

> Authorized historical Matches for a Subscription. Stable keyset page cursor, not a Change Cursor. Absence of a Match does not distinguish an evaluator still working from a negative result.



## OpenAPI

````yaml /openapi.yaml get /v0/matches
openapi: 3.1.0
info:
  title: Quivr V2 public text foundation contract
  version: 0.0.0-draft
  description: >-
    THE-543 and THE-547 evaluation contracts; endpoint implementations are
    separate work. Matching criterion is plugin-owned and deferred. One
    configured webhook destination, immutable Matches, independent at-least-once
    Delivery and reference-only notifications. OpenAPI is authoritative for
    transport shapes. THE-640 adds text search and asynchronous Corpus
    projection rebuild initiation.
servers: []
security:
  - ApiKey: []
paths:
  /v0/matches:
    get:
      tags:
        - Matches
      summary: List matches
      description: >-
        Authorized historical Matches for a Subscription. Stable keyset page
        cursor, not a Change Cursor. Absence of a Match does not distinguish an
        evaluator still working from a negative result.
      operationId: listMatches
      parameters:
        - name: subscription_id
          in: query
          required: true
          schema:
            type: string
            minLength: 1
        - name: page_cursor
          in: query
          schema:
            type: string
            minLength: 1
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchPage'
        default:
          description: >-
            Structured error. Existing /v0 authentication, scope, pagination and
            idempotency semantics apply.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    MatchPage:
      type: object
      additionalProperties: false
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Match'
        next_page_cursor:
          type: string
          minLength: 1
      required:
        - items
    Error:
      type: object
      additionalProperties: false
      properties:
        code:
          type: string
          minLength: 1
        message:
          type: string
          minLength: 1
        retryable:
          type: boolean
        field:
          type: string
          minLength: 1
          description: >-
            JSON Pointer (RFC 6901) to the request member that caused a 422,
            when known (for example /config/url or /credential/secret/token on
            connector commands).
        resync_url:
          type: string
          format: uri-reference
      required:
        - code
        - message
        - retryable
    Match:
      type: object
      additionalProperties: false
      properties:
        match_id:
          type: string
          minLength: 1
        subscription_id:
          type: string
          minLength: 1
        subscription_version_id:
          type: string
          minLength: 1
        saved_query_id:
          type: string
          minLength: 1
        saved_query_version_id:
          type: string
          minLength: 1
        record_id:
          type: string
          minLength: 1
        record_version_id:
          type: string
          minLength: 1
        previous_match_id:
          type: string
          minLength: 1
        owner:
          $ref: '#/components/schemas/SubscriptionOwner'
        evidence:
          $ref: '#/components/schemas/MatchEvidence'
      required:
        - match_id
        - subscription_id
        - subscription_version_id
        - saved_query_id
        - saved_query_version_id
        - record_id
        - record_version_id
        - evidence
      description: >-
        Immutable positive historical determination, not a claim of current
        eligibility. Unique subscription-version/record-version.
        Correction/withdrawal notifications reference history; no Match is
        fabricated for negative decisions. owner is the Subscription's owner,
        absent when global.
    SubscriptionOwner:
      type: string
      minLength: 1
      maxLength: 128
      description: >-
        Subscription Owner, an opaque end-user reference defined by the client
        application (for example user-123). Quivr stores, filters and echoes it
        without interpreting it. At most 128 characters without control
        characters; none is reserved for the listing filter (422 invalid_owner).
    MatchEvidence:
      type: object
      additionalProperties: false
      properties:
        evaluator:
          $ref: '#/components/schemas/EvaluatorConfig'
        explanation:
          type: string
          maxLength: 4096
        part_keys:
          type: array
          items:
            type: string
            minLength: 1
          maxItems: 100
        details:
          type: object
          additionalProperties: true
      required:
        - evaluator
        - explanation
      description: >-
        Immutable evidence for a positive result, including evaluator
        version/configuration. Details are plugin-defined, bounded to 16 KiB and
        schema-validated by its adapter; core checks referenced Parts. Access is
        rechecked on reads.
    EvaluatorConfig:
      type: object
      additionalProperties: false
      properties:
        plugin_id:
          type: string
          minLength: 1
        version:
          type: string
          minLength: 1
        configuration:
          type: object
          additionalProperties: true
      required:
        - plugin_id
        - version
        - configuration
      description: >-
        Pins an installed evaluator by plugin id and version, and its
        configuration. Evaluators are the subscription Contributions of the
        plugins pinned at startup (Plugin Protocol v0); test deployments may
        also install the deterministic fixture quivr.fixture@1. The
        configuration must satisfy the evaluator's declared configuration
        schema.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        API key, not necessarily a JWT. Server derives Organization, permitted
        actions and Corpus scope; every resource access is authorized.

````