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

> Browse through all conversations in your workspace to understand how users are interacting with your AI. Filter by product or version to focus on specific areas of your application.



## OpenAPI

````yaml https://www.greenflash.ai/api/openapi get /interactions
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:
  /interactions:
    get:
      tags:
        - Interactions
      summary: List Interactions
      description: >-
        Browse through all conversations in your workspace to understand how
        users are interacting with your AI. Filter by product or version to
        focus on specific areas of your application.
      parameters:
        - schema:
            type: number
            minimum: 1
            maximum: 100
            default: 50
            description: Maximum number of results to return.
          required: false
          description: Maximum number of results to return.
          name: limit
          in: query
        - schema:
            type: number
            minimum: 0
            description: Offset for pagination.
          required: false
          description: Offset for pagination.
          name: offset
          in: query
        - schema:
            type: number
            minimum: 1
            description: Page number
          required: false
          description: Page number
          name: page
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter interactions by product ID.
          required: false
          description: Filter interactions by product ID.
          name: productId
          in: query
        - schema:
            type: string
            format: uuid
            description: Filter interactions by version ID.
          required: false
          description: Filter interactions by version ID.
          name: versionId
          in: query
      responses:
        '200':
          description: Interactions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInteractionsResponse'
        '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 interactions operations.
        '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 interactions 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 listInteractionsResponse = await client.interactions.list();

            console.log(listInteractionsResponse);
        - 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_interactions_response = client.interactions.list()
            print(list_interactions_response)
components:
  schemas:
    ListInteractionsResponse:
      type: array
      items:
        $ref: '#/components/schemas/Interaction'
      description: Array of interactions.
    Interaction:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The interaction ID.
        externalId:
          type:
            - string
            - 'null'
          description: Your external identifier for the interaction.
        participantId:
          type: string
          format: uuid
          description: The user who participated in this interaction.
        externalParticipantId:
          type:
            - string
            - 'null'
          description: Your external identifier for the participant.
        organizationId:
          type:
            - string
            - 'null'
          format: uuid
          description: The organization ID.
        organizationExternalId:
          type:
            - string
            - 'null'
          description: Your external identifier for the organization.
        productId:
          type: string
          format: uuid
          description: The product ID.
        versionId:
          type: string
          format: uuid
          description: The version ID.
        model:
          type:
            - string
            - 'null'
          description: The AI model used.
        properties:
          type: object
          additionalProperties: {}
          description: Custom interaction properties.
        rating:
          type:
            - number
            - 'null'
          description: User rating for this interaction.
        ratingMin:
          type:
            - number
            - 'null'
          description: Minimum rating value.
        ratingMax:
          type:
            - number
            - 'null'
          description: Maximum rating value.
        feedback:
          type:
            - string
            - 'null'
          description: User feedback text.
        createdAt:
          type: string
          format: date-time
          description: When the interaction was created.
        updatedAt:
          type: string
          format: date-time
          description: When the interaction was last updated.
      required:
        - id
        - externalId
        - participantId
        - externalParticipantId
        - organizationId
        - organizationExternalId
        - productId
        - versionId
        - model
        - rating
        - ratingMin
        - ratingMax
        - feedback
        - createdAt
        - updatedAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````