> ## 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 Inbox Item

> Get the full detail of a single inbox item including conversation messages, analysis scores, trigger metadata, keywords, and participant information.



## OpenAPI

````yaml https://www.greenflash.ai/api/openapi get /inbox/{conversationId}
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:
  /inbox/{conversationId}:
    get:
      tags:
        - Inbox
      summary: Get Inbox Item
      description: >-
        Get the full detail of a single inbox item including conversation
        messages, analysis scores, trigger metadata, keywords, and participant
        information.
      parameters:
        - schema:
            type: string
            format: uuid
            description: The conversation ID to retrieve
          required: true
          description: The conversation ID to retrieve
          name: conversationId
          in: path
      responses:
        '200':
          description: Inbox item retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInboxItemResponse'
              example:
                conversationId: 123e4567-e89b-12d3-a456-426614174000
                topic: Billing dispute — charged twice for subscription
                triggerType: revenue_risk
                reviewStatus: unreviewed
                timestamp: '2025-10-15T09:32:00Z'
                messageCount: 8
                summary: >-
                  Customer reports being charged twice for their monthly
                  subscription. The assistant offered a refund but referenced an
                  incorrect policy. The customer became frustrated when the
                  refund timeline was unclear.
                triggers:
                  - triggerType: revenue_risk
                    reason: Customer threatening cancellation due to billing issue
                    severity: 4
                    source: sentiment_analysis
                    confidence: 0.92
                  - triggerType: guardrail
                    reason: Assistant cited incorrect refund policy
                    severity: 3
                    source: factual_check
                    confidence: 0.87
                messages:
                  - role: user
                    content: >-
                      I was charged twice for my subscription this month. What's
                      going on?
                    timestamp: '2025-10-15T09:30:00Z'
                  - role: assistant
                    content: >-
                      I'm sorry to hear that! Let me look into your account. I
                      can see the duplicate charge and will initiate a refund
                      right away.
                    timestamp: '2025-10-15T09:30:15Z'
                analysis:
                  sentiment:
                    label: negative
                    score: -0.6
                  frustration:
                    label: high
                    score: 0.78
                  struggle:
                    label: moderate
                    score: 0.45
                  qualityIndex: 4.2
                keywords:
                  - billing
                  - duplicate charge
                  - refund
                  - subscription
                  - cancellation
                participant:
                  id: 789e4567-e89b-12d3-a456-426614174002
                  externalId: user-456
                  name: Alice Example
                  email: alice@example.com
        '404':
          description: Inbox item 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 inbox item operations.
              example:
                success: false
                error: Inbox item 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 inbox item 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 getInboxItemResponse = await
            client.inbox.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');


            console.log(getInboxItemResponse.analysis);
        - 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_inbox_item_response = client.inbox.get(
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(get_inbox_item_response.analysis)
components:
  schemas:
    GetInboxItemResponse:
      type: object
      properties:
        conversationId:
          type: string
          format: uuid
          description: The conversation ID.
        topic:
          type:
            - string
            - 'null'
          description: Main topic of the conversation.
        triggerType:
          type:
            - string
            - 'null'
          description: Primary trigger type that flagged this conversation.
        reviewStatus:
          type: string
          enum:
            - unreviewed
            - reviewed
            - dismissed
          description: Current review status.
        timestamp:
          type: string
          format: date-time
          description: When the inbox item was created (ISO 8601).
        messageCount:
          type: integer
          description: Number of chat messages in the conversation.
        summary:
          type:
            - string
            - 'null'
          description: AI-generated summary of the conversation.
        triggers:
          type: array
          items:
            $ref: '#/components/schemas/TriggerDetail'
          description: All triggers associated with this conversation.
        messages:
          type: array
          items:
            $ref: '#/components/schemas/ConversationMessage'
          description: Conversation messages.
        analysis:
          $ref: '#/components/schemas/AnalysisScores'
        keywords:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Keywords extracted from the conversation.
        participant:
          $ref: '#/components/schemas/ParticipantInfo'
      required:
        - conversationId
        - topic
        - triggerType
        - reviewStatus
        - timestamp
        - messageCount
        - summary
        - triggers
        - messages
        - analysis
        - keywords
        - participant
    TriggerDetail:
      type: object
      properties:
        triggerType:
          type: string
          description: Type of trigger.
        reason:
          type:
            - string
            - 'null'
          description: Human-readable reason.
        severity:
          type: integer
          description: Severity level (1-5).
        source:
          type:
            - string
            - 'null'
          description: Source key of the trigger.
        confidence:
          type:
            - number
            - 'null'
          description: Confidence score of the trigger.
      required:
        - triggerType
        - reason
        - severity
        - source
        - confidence
    ConversationMessage:
      type: object
      properties:
        role:
          type: string
          description: Message role (e.g. "user", "assistant").
        content:
          type: string
          description: Message content.
        timestamp:
          type:
            - string
            - 'null'
          format: date-time
          description: When the message was sent (ISO 8601).
      required:
        - role
        - content
        - timestamp
    AnalysisScores:
      type:
        - object
        - 'null'
      properties:
        sentiment:
          type:
            - object
            - 'null'
          properties:
            label:
              type: string
            score:
              type: number
          required:
            - label
            - score
          description: Average user sentiment.
        frustration:
          type:
            - object
            - 'null'
          properties:
            label:
              type: string
            score:
              type: number
          required:
            - label
            - score
          description: Frustration level detected.
        struggle:
          type:
            - object
            - 'null'
          properties:
            label:
              type: string
            score:
              type: number
          required:
            - label
            - score
          description: Struggle level detected.
        qualityIndex:
          type:
            - number
            - 'null'
          description: Conversation quality index score.
      required:
        - sentiment
        - frustration
        - struggle
        - qualityIndex
      description: Analysis scores for this conversation.
    ParticipantInfo:
      type:
        - object
        - 'null'
      properties:
        id:
          type: string
          format: uuid
          description: Participant ID.
        externalId:
          type:
            - string
            - 'null'
          description: External participant ID.
        name:
          type:
            - string
            - 'null'
          description: Participant name.
        email:
          type:
            - string
            - 'null'
          description: Participant email.
      required:
        - id
        - externalId
        - name
        - email
      description: Participant information.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````