> ## 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.

# Export inbox conversations (CSV or JSON)

> Bulk-export the filtered omnichannel inbox for compliance audits, migration, or offline analytics. Accepts the same filter query params as `GET /conversations` (channel, status, tags, assignee, date range, segment, saved-view filter AST). `format=csv` (default) returns one flat row per conversation; `format=json` returns a structured array, and with `include_messages=true` each conversation carries its full transcript including attachments (media_url). Tenant-scoped; capped at 10,000 conversations (1,000 when transcripts are inlined) — `truncated` flags an overflow.



## OpenAPI

````yaml /openapi.yaml get /api/v1/conversations/export
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/export:
    get:
      tags:
        - Conversations
      summary: Export inbox conversations (CSV or JSON)
      description: >-
        Bulk-export the filtered omnichannel inbox for compliance audits,
        migration, or offline analytics. Accepts the same filter query params as
        `GET /conversations` (channel, status, tags, assignee, date range,
        segment, saved-view filter AST). `format=csv` (default) returns one flat
        row per conversation; `format=json` returns a structured array, and with
        `include_messages=true` each conversation carries its full transcript
        including attachments (media_url). Tenant-scoped; capped at 10,000
        conversations (1,000 when transcripts are inlined) — `truncated` flags
        an overflow.
      parameters:
        - schema:
            type: string
            enum:
              - csv
              - json
            default: csv
          in: query
          name: format
          required: false
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
          in: query
          name: include_messages
          required: false
          description: >-
            When true and format=json, inline each conversation's message
            transcript + attachments.
        - 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
        - schema:
            type: string
          in: query
          name: search
          required: false
        - schema:
            type: string
          in: query
          name: tag
          required: false
        - 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: >-
            A CSV or JSON download (Content-Disposition attachment). The format
            depends on the `format` query param.
          content:
            text/csv:
              schema:
                type: string
                description: >-
                  One flat row per conversation, with a header row. Returned
                  when format=csv (default).
            application/json:
              schema:
                type: object
                description: Structured export. Returned when format=json.
                properties:
                  exported_at:
                    type: string
                    description: >-
                      UTC date stamp (YYYY-MM-DD) of when the export was
                      generated.
                  truncated:
                    type: boolean
                    description: >-
                      True when the result hit the export cap (10,000
                      conversations, or 1,000 when include_messages=true) and
                      rows were dropped.
                  conversations:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                      description: >-
                        A conversation row. When include_messages=true, carries
                        a `messages` array with the full transcript (body,
                        direction, from/to, media_url, timestamps, metadata).
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_*)

````