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

# List Conversations

> Get all conversations of agents that user owns. With option to restrict to a specific agent.



## OpenAPI

````yaml GET /v1/voiceai/conversations
openapi: 3.1.0
info:
  title: Threetone API Documentation
  version: 1.0.0
servers:
  - url: https://api.threetone.in
    description: Production
security: []
paths:
  /v1/voiceai/conversations:
    get:
      tags:
        - Conversations
      summary: List Conversations
      description: >-
        Get all conversations of agents that user owns. With option to restrict
        to a specific agent.
      operationId: conversations_list
      parameters:
        - name: cursor
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Used for fetching next page. Cursor is returned in the response.
            title: Cursor
          description: Used for fetching next page. Cursor is returned in the response.
        - name: agent_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: The id of the agent you're taking the action on.
            title: Agent Id
          description: The id of the agent you're taking the action on.
        - name: call_successful
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/EvaluationSuccessResult'
              - type: 'null'
            description: The result of the success evaluation
            title: Call Successful
          description: The result of the success evaluation
        - name: call_start_before_unix
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              Unix timestamp (in seconds) to filter conversations up to this
              start date.
            title: Call Start Before Unix
          description: >-
            Unix timestamp (in seconds) to filter conversations up to this start
            date.
        - name: call_start_after_unix
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              Unix timestamp (in seconds) to filter conversations after this
              start date.
            title: Call Start After Unix
          description: >-
            Unix timestamp (in seconds) to filter conversations after this start
            date.
        - name: call_duration_min_secs
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Minimum call duration in seconds.
            title: Call Duration Min Secs
          description: Minimum call duration in seconds.
        - name: call_duration_max_secs
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: Maximum call duration in seconds.
            title: Call Duration Max Secs
          description: Maximum call duration in seconds.
        - name: rating_min
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 5
                minimum: 1
              - type: 'null'
            description: Minimum overall rating (1-5).
            title: Rating Min
          description: Minimum overall rating (1-5).
        - name: rating_max
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                maximum: 5
                minimum: 1
              - type: 'null'
            description: Maximum overall rating (1-5).
            title: Rating Max
          description: Maximum overall rating (1-5).
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: >-
              How many conversations to return at maximum. Can not exceed 100,
              defaults to 30.
            default: 30
            title: Page Size
          description: >-
            How many conversations to return at maximum. Can not exceed 100,
            defaults to 30.
        - name: summary_mode
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SummaryMode'
            description: Whether to include transcript summaries in the response.
            default: exclude
          description: Whether to include transcript summaries in the response.
        - name: exclude_batch
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              Exclude batch call conversations. Defaults to true (batch calls
              are viewed in the Batch Calling page).
            default: true
            title: Exclude Batch
          description: >-
            Exclude batch call conversations. Defaults to true (batch calls are
            viewed in the Batch Calling page).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConversationsPageResponseModel'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
        - HTTPBearer: []
components:
  schemas:
    EvaluationSuccessResult:
      type: string
      enum:
        - success
        - failure
        - unknown
      title: EvaluationSuccessResult
      description: Result of conversation success evaluation
    SummaryMode:
      type: string
      enum:
        - exclude
        - include
      title: SummaryMode
      description: Whether to include transcript summaries in response
    GetConversationsPageResponseModel:
      properties:
        conversations:
          items:
            $ref: '#/components/schemas/ConversationSummaryResponseModel'
          type: array
          title: Conversations
          description: List of conversation summaries
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          title: Next Cursor
          description: Cursor for fetching the next page
        has_more:
          type: boolean
          title: Has More
          description: Whether there are more conversations to fetch
      type: object
      required:
        - conversations
        - has_more
      title: GetConversationsPageResponseModel
      description: Paginated response for list conversations endpoint.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ConversationSummaryResponseModel:
      properties:
        agent_id:
          type: string
          title: Agent Id
          description: The ID of the agent
        branch_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Branch Id
          description: The ID of the agent branch (if applicable)
        agent_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Name
          description: The name of the agent
        conversation_id:
          type: string
          title: Conversation Id
          description: The unique identifier for the conversation
        start_time_unix_secs:
          type: integer
          title: Start Time Unix Secs
          description: Unix timestamp when the conversation started
        call_duration_secs:
          type: integer
          title: Call Duration Secs
          description: Duration of the call in seconds
        message_count:
          type: integer
          title: Message Count
          description: Number of messages in the conversation
        status:
          $ref: '#/components/schemas/ConversationStatus'
          description: Current status of the conversation
        call_successful:
          $ref: '#/components/schemas/EvaluationSuccessResult'
          description: Whether the call was evaluated as successful
        transcript_summary:
          anyOf:
            - type: string
            - type: 'null'
          title: Transcript Summary
          description: AI-generated summary of the transcript (short paragraph)
        direction:
          anyOf:
            - $ref: '#/components/schemas/ConversationDirection'
            - type: 'null'
          description: Direction of the call (inbound/outbound/web)
        rating:
          anyOf:
            - type: number
            - type: 'null'
          title: Rating
          description: User rating for the conversation (1-5)
        initiation_source:
          anyOf:
            - type: string
            - type: 'null'
          title: Initiation Source
          description: Source that initiated the call (sip, web, batch_call, test_call)
        voicemail_detected:
          type: boolean
          title: Voicemail Detected
          description: Whether a voicemail was detected and left during this call
          default: false
        termination_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Termination Reason
          description: >-
            Human-readable reason the call ended (aligned with conversation
            detail metadata)
      type: object
      required:
        - agent_id
        - conversation_id
        - start_time_unix_secs
        - call_duration_secs
        - message_count
        - status
        - call_successful
      title: ConversationSummaryResponseModel
      description: Summary model for a conversation in list responses.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    ConversationStatus:
      type: string
      enum:
        - initiated
        - in-progress
        - processing
        - done
        - failed
      title: ConversationStatus
      description: Status of a conversation (GetConversationResponseModelStatus)
    ConversationDirection:
      type: string
      enum:
        - inbound
        - outbound
        - web
      title: ConversationDirection
      description: |-
        Direction of a conversation.

        - inbound: Phone call received (SIP/Twilio)
        - outbound: Phone call initiated by agent
        - web: Web widget / dashboard talk-to initiated conversation
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: API key for programmatic access
      in: header
      name: x-api-key
    HTTPBearer:
      type: http
      description: JWT Bearer token for dashboard access
      scheme: bearer

````