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

# Current Review Matches

> Read current review rows, including rejected pairs, in stable match-ID order.

Pages are live. Start without a cursor to reconcile subsequent decisions. Counts
apply item/competitor filters but omit the selected review status.



## OpenAPI

````yaml https://clientapi.retailgrid.io/openapi.json get /v1/matching/matches
openapi: 3.1.0
info:
  title: Retailgrid Public API
  version: v1
servers: []
security: []
paths:
  /v1/matching/matches:
    get:
      tags:
        - matching
      summary: Current Review Matches
      description: >-
        Read current review rows, including rejected pairs, in stable match-ID
        order.


        Pages are live. Start without a cursor to reconcile subsequent
        decisions. Counts

        apply item/competitor filters but omit the selected review status.
      operationId: current_review_matches_v1_matching_matches_get
      parameters:
        - name: status
          in: query
          required: false
          schema:
            enum:
              - ''
              - auto
              - needs_review
              - approved
              - rejected
            type: string
            default: ''
            title: Status
        - name: competitor
          in: query
          required: false
          schema:
            type: string
            maxLength: 256
            default: ''
            title: Competitor
        - name: rg_item_id
          in: query
          required: false
          schema:
            type: string
            maxLength: 128
            default: ''
            title: Rg Item Id
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 4096
                minLength: 1
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceCursorPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WorkspaceCursorPage:
      properties:
        external_org_id:
          type: string
          format: uuid
          title: External Org Id
        matches:
          items:
            $ref: '#/components/schemas/WorkspaceMatch'
          type: array
          maxItems: 100
          title: Matches
        counts:
          $ref: '#/components/schemas/WorkspaceCounts'
        total:
          type: integer
          minimum: 0
          title: Total
        next_cursor:
          anyOf:
            - type: string
              maxLength: 4096
              minLength: 1
            - type: 'null'
          title: Next Cursor
        has_more:
          type: boolean
          title: Has More
      additionalProperties: false
      type: object
      required:
        - external_org_id
        - matches
        - counts
        - total
        - next_cursor
        - has_more
      title: WorkspaceCursorPage
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkspaceMatch:
      properties:
        match_id:
          type: string
          title: Match Id
        version:
          type: integer
          exclusiveMinimum: 0
          title: Version
        rg_item_id:
          type: string
          title: Rg Item Id
        competitor_product_id:
          type: string
          title: Competitor Product Id
        competitor:
          $ref: '#/components/schemas/MatchCompetitor'
        product:
          $ref: '#/components/schemas/MatchProduct'
        match:
          $ref: '#/components/schemas/MatchEvidence'
        offer:
          anyOf:
            - $ref: '#/components/schemas/MatchOffer'
            - type: 'null'
        matched_at:
          type: string
          title: Matched At
        our_product:
          anyOf:
            - type: string
            - type: 'null'
          title: Our Product
        our_details:
          $ref: '#/components/schemas/MatchTarget'
        review:
          $ref: '#/components/schemas/ReviewInfo'
        link_decision:
          anyOf:
            - $ref: '#/components/schemas/LinkDecision'
            - type: 'null'
        latest_decided_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Latest Decided At
      type: object
      required:
        - match_id
        - version
        - rg_item_id
        - competitor_product_id
        - competitor
        - product
        - match
        - offer
        - matched_at
        - our_details
        - review
      title: WorkspaceMatch
    WorkspaceCounts:
      properties:
        needs_review:
          type: integer
          minimum: 0
          title: Needs Review
          default: 0
        auto:
          type: integer
          minimum: 0
          title: Auto
          default: 0
        approved:
          type: integer
          minimum: 0
          title: Approved
          default: 0
        rejected:
          type: integer
          minimum: 0
          title: Rejected
          default: 0
      additionalProperties: false
      type: object
      title: WorkspaceCounts
    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
    MatchCompetitor:
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
          title: Id
        name:
          type: string
          title: Name
        domain:
          type: string
          title: Domain
      type: object
      required:
        - id
        - name
        - domain
      title: MatchCompetitor
    MatchProduct:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        url:
          type: string
          title: Url
        sku:
          anyOf:
            - type: string
            - type: 'null'
          title: Sku
        barcode:
          anyOf:
            - type: string
            - type: 'null'
          title: Barcode
        brand:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand
        size:
          anyOf:
            - type: string
            - type: 'null'
          title: Size
        unit:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit
        image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Url
      type: object
      required:
        - name
        - url
        - sku
        - barcode
        - brand
        - size
        - unit
        - image_url
      title: MatchProduct
    MatchEvidence:
      properties:
        relation:
          type: string
          enum:
            - direct
            - substitute
            - unknown
          title: Relation
        method:
          anyOf:
            - type: string
            - type: 'null'
          title: Method
        confidence:
          anyOf:
            - type: number
            - type: 'null'
          title: Confidence
        is_manual:
          type: boolean
          title: Is Manual
      type: object
      required:
        - relation
        - method
        - confidence
        - is_manual
      title: MatchEvidence
    MatchOffer:
      properties:
        price:
          anyOf:
            - $ref: '#/components/schemas/MatchMoney'
            - type: 'null'
        regular_price:
          anyOf:
            - $ref: '#/components/schemas/MatchMoney'
            - type: 'null'
        promo_price:
          anyOf:
            - $ref: '#/components/schemas/MatchMoney'
            - type: 'null'
        availability:
          type: string
          title: Availability
        observed_at:
          type: string
          title: Observed At
        assurance:
          type: string
          title: Assurance
      type: object
      required:
        - price
        - regular_price
        - promo_price
        - availability
        - observed_at
        - assurance
      title: MatchOffer
    MatchTarget:
      properties:
        item_id:
          type: string
          title: Item Id
        name:
          type: string
          title: Name
        image_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Url
        price:
          anyOf:
            - type: number
            - type: 'null'
          title: Price
        currency:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency
        brand:
          anyOf:
            - type: string
            - type: 'null'
          title: Brand
        barcode:
          anyOf:
            - type: string
            - type: 'null'
          title: Barcode
        sku:
          anyOf:
            - type: string
            - type: 'null'
          title: Sku
        size:
          anyOf:
            - type: string
            - type: 'null'
          title: Size
        unit:
          anyOf:
            - type: string
            - type: 'null'
          title: Unit
        variant_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Variant Name
        color:
          anyOf:
            - type: string
            - type: 'null'
          title: Color
        product_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Product Url
        stock:
          anyOf:
            - type: number
            - type: 'null'
          title: Stock
      type: object
      required:
        - item_id
        - name
      title: MatchTarget
    ReviewInfo:
      properties:
        status:
          type: string
          enum:
            - auto
            - needs_review
            - approved
            - rejected
          title: Status
        revision:
          type: integer
          title: Revision
        evidence:
          type: string
          title: Evidence
        reasons:
          items:
            type: string
          type: array
          title: Reasons
        actor:
          anyOf:
            - type: string
            - type: 'null'
          title: Actor
        decided_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Decided At
        note:
          type: string
          title: Note
          default: ''
        action:
          anyOf:
            - type: string
              enum:
                - approve
                - reject
                - reopen
                - rematch
            - type: 'null'
          title: Action
      additionalProperties: false
      type: object
      required:
        - status
        - revision
        - evidence
        - reasons
      title: ReviewInfo
    LinkDecision:
      properties:
        action:
          type: string
          enum:
            - add
            - remove
          title: Action
        actor:
          type: string
          title: Actor
        decided_at:
          type: string
          format: date-time
          title: Decided At
      additionalProperties: false
      type: object
      required:
        - action
        - actor
        - decided_at
      title: LinkDecision
    MatchMoney:
      properties:
        amount:
          type: string
          title: Amount
        currency:
          type: string
          title: Currency
      type: object
      required:
        - amount
        - currency
      title: MatchMoney

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.