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

> List conversations that have been flagged for review. Filter by review status, trigger type, or severity to focus on what matters most. Results are ordered by attention score (unreviewed) or last updated (reviewed/dismissed).



## OpenAPI

````yaml https://www.greenflash.ai/api/openapi get /inbox
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:
    get:
      tags:
        - Inbox
      summary: List Inbox Items
      description: >-
        List conversations that have been flagged for review. Filter by review
        status, trigger type, or severity to focus on what matters most. Results
        are ordered by attention score (unreviewed) or last updated
        (reviewed/dismissed).
      parameters:
        - schema:
            type: string
            enum:
              - unreviewed
              - reviewed
              - dismissed
            default: unreviewed
            description: Filter by review status. Defaults to "unreviewed".
          required: false
          description: Filter by review status. Defaults to "unreviewed".
          name: status
          in: query
        - schema:
            type: string
            enum:
              - guardrail
              - expectation_check
              - novelty
              - manual_review
              - revenue_risk
            description: Filter by trigger type.
          required: false
          description: Filter by trigger type.
          name: triggerType
          in: query
        - schema:
            type: string
            enum:
              - attention
              - opportunity
            description: >-
              Filter by axis: "attention" for risk/quality triggers,
              "opportunity" for positive business signals.
          required: false
          description: >-
            Filter by axis: "attention" for risk/quality triggers, "opportunity"
            for positive business signals.
          name: axis
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 5
            description: Minimum severity level to include (1-5).
          required: false
          description: Minimum severity level to include (1-5).
          name: minSeverity
          in: query
      responses:
        '200':
          description: Inbox items retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInboxResponse'
              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
                - conversationId: 223e4567-e89b-12d3-a456-426614174001
                  topic: Bot gave incorrect refund policy
                  triggerType: guardrail
                  reviewStatus: unreviewed
                  timestamp: '2025-10-15T08:17:00Z'
                  messageCount: 5
        '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 inbox operations.
              example:
                success: false
                error: 'Invalid parameter: minSeverity must be between 1 and 5'
        '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 inbox 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 listInboxResponse = await client.inbox.list();

            console.log(listInboxResponse);
        - 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_inbox_response = client.inbox.list()
            print(list_inbox_response)
components:
  schemas:
    ListInboxResponse:
      type: array
      items:
        $ref: '#/components/schemas/InboxItemSummary'
      description: Array of inbox items. Pagination via Link header.
    InboxItemSummary:
      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.
        axis:
          type: string
          enum:
            - attention
            - opportunity
            - manual
          description: >-
            Top-level axis for this item: attention (risk), opportunity
            (positive signal), or manual (team flagged).
        clusterSize:
          type: integer
          description: >-
            When this card represents a root-cause cluster, total number of
            conversations sharing the cause.
        clusterMemberIds:
          type: array
          items:
            type: string
            format: uuid
          description: IDs of the other conversations in the cluster.
        clusterRootCause:
          type:
            - string
            - 'null'
          description: Root-cause label that anchors the cluster.
      required:
        - conversationId
        - topic
        - triggerType
        - reviewStatus
        - timestamp
        - messageCount
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````