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

# List conversations

> Retrieve a list of conversations with optional filtering by date ranges.



## OpenAPI

````yaml api-reference/openapi3.json get /conversations
openapi: 3.0.0
info:
  title: Operator API
  version: '2025-06-19'
  description: API for Operator
servers:
  - url: https://api.operator.xyz
security: []
paths:
  /conversations:
    get:
      tags:
        - Conversations
      summary: List conversations
      description: Retrieve a list of conversations with optional filtering by date ranges.
      parameters:
        - name: Operator-Version
          in: header
          required: true
          schema:
            type: string
            enum:
              - '2025-06-19'
          description: The API version to use.
          example: '2025-06-19'
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            default: null
            description: Cursor to paginate through the conversations.
          description: Cursor to paginate through the conversations.
        - name: created_at_gte
          in: query
          required: false
          schema:
            format: date-time
            type: string
            default: null
            description: Filter conversations created after this date.
          description: Filter conversations created after this date.
        - name: created_at_lt
          in: query
          required: false
          schema:
            format: date-time
            type: string
            default: null
            description: Filter conversations created before this date.
          description: Filter conversations created before this date.
        - name: completed_at_gte
          in: query
          required: false
          schema:
            format: date-time
            type: string
            default: null
            description: Filter conversations completed after this date.
          description: Filter conversations completed after this date.
        - name: completed_at_lt
          in: query
          required: false
          schema:
            format: date-time
            type: string
            default: null
            description: Filter conversations completed before this date.
          description: Filter conversations completed before this date.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                description: Response object for listing conversations.
                properties:
                  data:
                    description: List of conversations.
                    items:
                      $ref: '#/components/schemas/ListConversationItem'
                      title: list.conversation.item
                    type: array
                  cursor:
                    type: string
                    default: null
                    description: >-
                      Pass this value to the `cursor` parameter to get the next
                      page of conversations.
                required:
                  - data
                type: object
        '404':
          description: The requested resource was not found.
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  data: {}
      security:
        - BearerAuth: []
components:
  schemas:
    ListConversationItem:
      description: A conversation item in the list.
      properties:
        id:
          description: Unique identifier for the conversation, e.g. `conv_8qm9JBCiTe7`.
          type: string
        agent_id:
          description: >-
            Version-specific identifier for the agent that handled the
            conversation, e.g. `ca_8qm9JBCiTe7@v0`.
          type: string
        customer_id:
          type: string
          default: null
          description: Unique identifier for the customer, e.g. `cus_8qm9JBCiTe7`.
        channel_type:
          enum:
            - phone
            - chat_realtime
            - chat_async
          type: string
          default: null
          description: The channel of the conversation.
        livemode:
          description: Whether the conversation is in livemode.
          type: boolean
        created_at:
          description: When the conversation was created.
          format: date-time
          type: string
        started_at:
          format: date-time
          type: string
          default: null
          description: When the conversation was started.
        completed_at:
          format: date-time
          type: string
          default: null
          description: When the conversation was completed.
        direction:
          description: The direction of the conversation.
          enum:
            - inbound
            - outbound
          type: string
        status:
          description: The status of the conversation.
          enum:
            - queued
            - in-progress
            - completed
            - voicemail
            - failed
            - busy
            - no-answer
          type: string
        failure_reason:
          enum:
            - dial_failed
            - number_marked_disconnected
            - pstn_blocked
            - dnc_rejected
            - tcpa_rejected
            - number_invalid
            - internal_error
            - twilio_error
            - agent_timeout
            - customer_requested_dnc
          type: string
          default: null
          description: >-
            The reason for the conversation failure, only set when status is
            `failed`.
        custom_fields:
          additionalProperties: true
          description: >-
            Additional key-value pairs attached to the conversation. These can
            be used to store arbitrary data by procedural agents.
          type: object
        duration_sec:
          type: integer
          default: null
          description: The duration of the conversation in seconds.
        sentiment:
          type: string
          default: null
          description: The sentiment of the customer during the conversation.
      required:
        - id
        - agent_id
        - livemode
        - created_at
        - direction
        - status
        - custom_fields
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````