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

# List all conversations

> Unified omnichannel inbox view across SMS, WhatsApp, email, Instagram, Messenger, RCS, Viber, and LINE. Each conversation represents a unique contact + channel pair.



## OpenAPI

````yaml /openapi.yaml get /api/v1/conversations/
openapi: 3.1.0
info:
  title: Devotel CPaaS API
  description: Orbit by Devotel — Communications Platform as a Service API
  version: 1.0.0
  contact:
    name: Devotel
    url: https://devotel.io
    email: support@devotel.io
  license:
    name: Proprietary
servers:
  - url: https://api.orbit.devotel.io
    description: Production
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Messages
    description: >-
      Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
      Viber, etc.)
  - name: Fax
    description: >-
      List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
      (sending flows through the Messaging API)
  - name: Agents
    description: AI agent creation, configuration, and execution
  - name: Voice
    description: Voice calls, IVR, conferencing, and SIP trunking
  - name: OnCall
    description: On-call rotations and escalation policy planning for incident alerting
  - name: Webhooks
    description: Webhook endpoint management and delivery logs
  - name: Numbers
    description: Phone number search, provisioning, and configuration
  - name: Brand Identity
    description: >-
      Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
      RCS, branded calling, number KYC)
  - name: Contacts
    description: Contact management, segmentation, and lifecycle tracking
  - name: Campaigns
    description: Marketing campaign orchestration and analytics
  - name: Flows
    description: Automation flow builder and execution engine
  - name: Templates
    description: Message template management and approval workflows
  - name: Settings
    description: Organization, channel, and user preference settings
  - name: Verify
    description: OTP generation and verification across channels
  - name: Push
    description: Push notification delivery via FCM and APNs
  - name: Integrations
    description: Third-party service connections and OAuth management
  - name: CDP
    description: >-
      Customer Data Platform — activation surface (CRM object sync, streaming
      destinations, ad-audience activation)
  - name: Files
    description: >-
      Server-to-server media upload, listing, retrieval, and deletion
      (signed-URL backed)
  - name: Commerce
    description: >-
      Omnichannel conversational-commerce — persistent cart + checkout state
      machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
      and AP2-style agent payment mandates.
  - name: Sync
    description: >-
      Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
      Lists, and ephemeral Streams, with change events relayed over the
      /api/v1/ws/sync WebSocket gateway
paths:
  /api/v1/conversations/:
    get:
      tags:
        - Conversations
      summary: List all conversations
      description: >-
        Unified omnichannel inbox view across SMS, WhatsApp, email, Instagram,
        Messenger, RCS, Viber, and LINE. Each conversation represents a unique
        contact + channel pair.
      parameters:
        - schema:
            type: string
          in: query
          name: cursor
          required: false
          description: Pagination cursor
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          in: query
          name: limit
          required: false
        - schema:
            type: string
          in: query
          name: sort
          required: false
          description: Sort field (prefix with - for DESC)
        - schema:
            type: string
            enum:
              - sms
              - whatsapp
              - email
              - rcs
              - viber
              - instagram
              - messenger
              - line
              - telegram
              - agent
              - voice
              - video
              - apple_messages
              - web_chat
          in: query
          name: channel
          required: false
        - schema:
            type: string
            enum:
              - open
              - closed
              - pending
              - snoozed
              - active
              - archived
              - resolved
          in: query
          name: status
          required: false
        - schema:
            type: string
          in: query
          name: assigned_agent
          required: false
          description: Filter by assigned agent ID (legacy)
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Search by contact name, phone, or email
        - schema:
            type: string
          in: query
          name: tag
          required: false
          description: Filter by tag (legacy, single)
        - schema:
            type: string
          in: query
          name: channels
          required: false
          description: Comma-separated list of channels
        - schema:
            type: string
          in: query
          name: statuses
          required: false
          description: Comma-separated list of statuses (open,closed,pending,snoozed,...)
        - schema:
            type: string
          in: query
          name: tags
          required: false
          description: Comma-separated tag list (ANY match)
        - schema:
            type: string
          in: query
          name: assignee
          required: false
          description: '"me", "unassigned", or a user id'
        - schema:
            type: string
            format: date-time
          in: query
          name: date_from
          required: false
        - schema:
            type: string
            format: date-time
          in: query
          name: date_to
          required: false
        - schema:
            type: string
          in: query
          name: segment_id
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: unread
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: has_agent
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: has_video_room
          required: false
        - schema:
            type: string
            enum:
              - positive
              - neutral
              - negative
          in: query
          name: sentiment
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: mentioned_internal
          required: false
        - schema:
            type: string
          in: query
          name: filters
          required: false
          description: JSON-encoded full filter AST (takes precedence)
      responses:
        '200':
          description: Paginated list of conversations
          content:
            application/json:
              schema:
                type: object
                description: Paginated list of conversations
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                      properties:
                        id:
                          type: string
                        contact_id:
                          type:
                            - 'null'
                            - string
                        channel:
                          type: string
                        status:
                          type: string
                        assigned_agent_id:
                          type:
                            - 'null'
                            - string
                        last_message_at:
                          type:
                            - 'null'
                            - string
                          format: date-time
                        last_message_preview:
                          type:
                            - 'null'
                            - string
                        last_message_direction:
                          type:
                            - 'null'
                            - string
                        unread_count:
                          type:
                            - 'null'
                            - integer
                        tags:
                          type: array
                          items:
                            type: string
                        subject:
                          type:
                            - 'null'
                            - string
                        priority:
                          type:
                            - 'null'
                            - string
                        contact_name:
                          type:
                            - 'null'
                            - string
                        contact_phone:
                          type:
                            - 'null'
                            - string
                        contact_email:
                          type:
                            - 'null'
                            - string
                        contact_avatar_url:
                          type:
                            - 'null'
                            - string
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type:
                            - 'null'
                            - string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                      pagination:
                        type: object
                        properties:
                          cursor:
                            type: string
                            nullable: true
                            description: >-
                              Opaque cursor to fetch the next page (null when no
                              more pages)
                          has_more:
                            type: boolean
                            description: Whether more results exist beyond this page
                          total:
                            type: integer
                            description: Total number of items matching the query
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard JWT token from Clerk
    ApiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: Server-to-server API key (dv_live_sk_*)

````