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

# List Products

> List all products in your workspace. Returns a summary view of each product with pagination support. Available on all plans.



## OpenAPI

````yaml https://www.greenflash.ai/api/openapi get /products
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:
    get:
      tags:
        - Products
      summary: List Products
      description: >-
        List all products in your workspace. Returns a summary view of each
        product with pagination support. Available on all plans.
      parameters:
        - schema:
            type: number
            minimum: 1
            description: Page number (default 1).
          required: false
          description: Page number (default 1).
          name: page
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 100
            description: Number of results per page (default 50, max 100).
          required: false
          description: Number of results per page (default 50, max 100).
          name: pageSize
          in: query
      responses:
        '200':
          description: Products retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProductsResponse'
              example:
                - id: 123e4567-e89b-12d3-a456-426614174000
                  name: Customer Support Bot
                  icon: headset
                  color: '#4F46E5'
                  createdAt: '2025-06-15T10:00:00Z'
                  updatedAt: '2025-10-01T14:30:00Z'
                - id: 223e4567-e89b-12d3-a456-426614174001
                  name: Sales Assistant
                  icon: chart-bar
                  color: '#059669'
                  createdAt: '2025-07-20T08:00:00Z'
                  updatedAt: '2025-09-28T11:00:00Z'
        '400':
          description: Bad request - invalid parameters
          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 list products operations.
              example:
                success: false
                error: 'Invalid parameter: pageSize must be between 1 and 100'
        '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 list products 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 listProductsResponse = await client.products.list();

            console.log(listProductsResponse);
        - 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
            )
            list_products_response = client.products.list()
            print(list_products_response)
components:
  schemas:
    ListProductsResponse:
      type: array
      items:
        $ref: '#/components/schemas/ProductSummary'
      description: Array of products.
    ProductSummary:
      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.
        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
        - createdAt
        - updatedAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````