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

# Get Product

> Get detailed configuration data for a specific product, including description, optimization notes, team members, and quality index metric weights. Available on all plans.



## OpenAPI

````yaml https://www.greenflash.ai/api/openapi get /products/{productId}
openapi: 3.1.0
info:
  title: Greenflash API Reference
  version: 1.0.0
  description: >-
    Greenflash endpoints for capturing interactions, managing prompts, and
    identifying users.
servers:
  - url: https://www.greenflash.ai/api/v1
    description: Greenflash API v1
security: []
tags:
  - name: Interactions
    description: Capture interactions between users and AI
  - name: Business Events
    description: Capture business events
  - name: Analytics
    description: Understand chat and agentic interactions analyses
  - name: Inbox
    description: Review flagged conversations
  - name: Segments
    description: Manage user segments
  - name: Prompts
    description: Manage prompts
  - name: Chat
    description: Stream chat and agentic conversations
  - name: Models
    description: Manage AI models
  - name: Products
    description: Manage products
  - name: Users
    description: Manage users
  - name: Organizations
    description: Manage organizations
paths:
  /products/{productId}:
    get:
      tags:
        - Products
      summary: Get Product
      description: >-
        Get detailed configuration data for a specific product, including
        description, optimization notes, team members, and quality index metric
        weights. Available on all plans.
      parameters:
        - schema:
            type: string
            format: uuid
            description: The product ID to retrieve
          required: true
          description: The product ID to retrieve
          name: productId
          in: path
      responses:
        '200':
          description: Product retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductResponse'
              example:
                id: 123e4567-e89b-12d3-a456-426614174000
                name: Customer Support Bot
                icon: headset
                color: '#4F46E5'
                description: >-
                  AI-powered customer support chatbot for the main website.
                  Handles billing inquiries, product questions, and account
                  management.
                optimizationNotes: >-
                  Focus on reducing hallucination in refund policy answers.
                  Ensure the bot always links to the latest pricing page.
                userPrivacy: standard
                members:
                  - id: 789e4567-e89b-12d3-a456-426614174010
                    userId: user_abc123
                    role: owner
                    avatarUrl: https://img.clerk.com/abc123
                  - id: 789e4567-e89b-12d3-a456-426614174011
                    userId: user_def456
                    role: member
                    avatarUrl: null
                qualityIndexMetricWeights:
                  - key: satisfaction
                    weight: 0.35
                    name: Satisfaction
                    description: Overall customer satisfaction score.
                  - key: safety
                    weight: 0.3
                    name: Safety
                    description: Safety and compliance adherence.
                  - key: friction
                    weight: 0.2
                    name: Friction
                    description: User friction and struggle indicators.
                  - key: growth
                    weight: 0.15
                    name: Growth
                    description: Growth and commercial intent metrics.
                createdAt: '2025-06-15T10:00:00Z'
                updatedAt: '2025-10-01T14:30:00Z'
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the API call was successful (false for errors).
                  error:
                    type: string
                    description: Error message describing what went wrong.
                description: Error response for get product operations.
              example:
                success: false
                error: Product not found
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Whether the API call was successful (false for errors).
                  error:
                    type: string
                    description: Error message describing what went wrong.
                description: Error response for get product operations.
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Greenflash from 'greenflash';


            const client = new Greenflash({
              apiKey: process.env['GREENFLASH_API_KEY'], // This is the default and can be omitted
            });


            const getProductResponse = await
            client.products.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');


            console.log(getProductResponse.id);
        - lang: Python
          source: |-
            import os
            from greenflash import Greenflash

            client = Greenflash(
                api_key=os.environ.get("GREENFLASH_API_KEY"),  # This is the default and can be omitted
            )
            get_product_response = client.products.get(
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(get_product_response.id)
components:
  schemas:
    GetProductResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The product ID.
        name:
          type: string
          description: The product name.
        icon:
          type:
            - string
            - 'null'
          description: Product icon identifier.
        color:
          type:
            - string
            - 'null'
          description: Product color hex code.
        description:
          type:
            - string
            - 'null'
          description: Product description.
        optimizationNotes:
          type:
            - string
            - 'null'
          description: AI optimization notes for the product.
        userPrivacy:
          type: string
          description: User privacy setting.
        members:
          type: array
          items:
            $ref: '#/components/schemas/ProductMember'
          description: Product team members.
        qualityIndexMetricWeights:
          type: array
          items:
            $ref: '#/components/schemas/QualityIndexMetricWeight'
          description: Quality index metric weight configuration.
        createdAt:
          type: string
          description: When the product was created (ISO 8601).
        updatedAt:
          type: string
          description: When the product was last updated (ISO 8601).
      required:
        - id
        - name
        - icon
        - color
        - description
        - optimizationNotes
        - userPrivacy
        - members
        - qualityIndexMetricWeights
        - createdAt
        - updatedAt
    ProductMember:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The member record ID.
        userId:
          type: string
          description: The user ID.
        role:
          type: string
          description: The member role.
        avatarUrl:
          type:
            - string
            - 'null'
          description: Avatar URL of the member.
      required:
        - id
        - userId
        - role
        - avatarUrl
    QualityIndexMetricWeight:
      type: object
      properties:
        key:
          type: string
          description: The metric key.
        weight:
          type: number
          description: The metric weight (0-1).
        name:
          type: string
          description: Human-readable metric name.
        description:
          type: string
          description: Metric description.
      required:
        - key
        - weight
        - name
        - description
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````