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

# Get a product

> Read one shared product by its exact opaque ID returned by listProducts, with complete configured availability. No slug or name lookup and no query parameters. Responses are private, no-store.



## OpenAPI

````yaml /openapi.json get /products/{id}
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /products/{id}:
    get:
      tags:
        - Products
      summary: Get a product
      description: >-
        Read one shared product by its exact opaque ID returned by listProducts,
        with complete configured availability. No slug or name lookup and no
        query parameters. Responses are private, no-store.
      operationId: getProduct
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: The product.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2Product'
        '400':
          description: Invalid request; this operation accepts no query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Missing or invalid credentials, or credential scope denied.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: The credential does not permit this operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Product not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '429':
          description: Rate limited. Honor Retry-After (seconds) when provided.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Dependency unavailable. Honor Retry-After (seconds).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2Product:
      type: object
      properties:
        id:
          type: string
          description: Opaque canonical product_… ID. Use exactly as returned.
        name:
          type: string
        type:
          type: string
          description: Line of Business; open text.
        admitted:
          type: boolean
        predecessorProductId:
          type: string
          nullable: true
        note:
          type: string
          nullable: true
        group:
          type: object
          nullable: true
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
          description: Configured group with its managed carrier_group_ ID, or null.
        mga:
          type: object
          nullable: true
          properties:
            id:
              type: string
            name:
              type: string
          required:
            - id
            - name
          additionalProperties: false
          description: Configured MGA with its managed mga_ ID, or null.
        availability:
          type: array
          items:
            type: object
            properties:
              state:
                type: string
              writingCompanies:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      nullable: true
                    naic:
                      type: string
                    name:
                      type: string
                  required:
                    - id
                    - naic
                    - name
                  additionalProperties: false
                description: >-
                  IDs are canonical carrier_ IDs, or null when the directory has
                  no profile. naic retains the source code. SERFF order: lead
                  filer first, then co-filers. A missing carrier profile uses
                  its NAIC code as its display name.
              toiCodes:
                type: array
                nullable: true
                items:
                  type: string
              subtoiCodes:
                type: array
                nullable: true
                items:
                  type: string
              note:
                type: string
                nullable: true
            required:
              - state
              - writingCompanies
              - toiCodes
              - subtoiCodes
              - note
            additionalProperties: false
          description: >-
            Complete configured availability, ordered by state, including rows
            not matching list filters.
      required:
        - id
        - name
        - type
        - admitted
        - predecessorProductId
        - note
        - group
        - mga
        - availability
      additionalProperties: false
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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