> ## 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.

# Observation Competitors



## OpenAPI

````yaml https://clientapi.retailgrid.io/openapi.json get /v1/competitor_prices/competitors
openapi: 3.1.0
info:
  title: Retailgrid Public API
  version: v1
servers: []
security: []
paths:
  /v1/competitor_prices/competitors:
    get:
      tags:
        - competitor_prices
      summary: Observation Competitors
      operationId: observation_competitors_v1_competitor_prices_competitors_get
      parameters:
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 256
              - type: 'null'
            title: Q
        - name: competitor_ids
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              maxLength: 128
              minLength: 1
            maxItems: 200
            title: Competitor Ids
        - name: currency_codes
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              pattern: ^[A-Z]{3}$
            maxItems: 50
            title: Currency Codes
        - name: statuses
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              maxLength: 128
            maxItems: 50
            title: Statuses
        - name: competitor_names
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
              maxLength: 256
            maxItems: 200
            title: Competitor Names
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 4096
              - type: 'null'
            title: Cursor
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 200
            minimum: 1
            default: 100
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ObservationCompetitorPage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ObservationCompetitorPage:
      properties:
        external_org_id:
          type: string
          format: uuid
          title: External Org Id
        items:
          items:
            $ref: '#/components/schemas/ObservationCompetitor'
          type: array
          maxItems: 200
          title: Items
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
        has_more:
          type: boolean
          title: Has More
      additionalProperties: false
      type: object
      required:
        - external_org_id
        - items
        - next_cursor
        - has_more
      title: ObservationCompetitorPage
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ObservationCompetitor:
      properties:
        competitor_id:
          type: string
          maxLength: 128
          minLength: 1
          title: Competitor Id
        competitor_name:
          type: string
          title: Competitor Name
        currency_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency Code
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        observation_count:
          type: integer
          minimum: 1
          title: Observation Count
      additionalProperties: false
      type: object
      required:
        - competitor_id
        - competitor_name
        - observation_count
      title: ObservationCompetitor
    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

````

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