> ## 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 an ad-hoc audience as CSV

> Resolve an ad-hoc audience — an unsaved segment filter AST, the same shape the segment builder and `POST /api/v1/segments/auto-suggest` produce — live against the tenant's contacts and download the matched rows as an RFC-4180 CSV attachment, without first persisting or materialising a segment. PII columns (phone, email) honour the caller's role + reveal context. Requires the `contacts:write` scope (owner / admin / developer). Hard-capped at 50,000 rows; a truncated export sets the `X-Export-Truncated: true` response header. The saved-segment equivalent is `GET /api/v1/contacts/segments/{id}/export.csv`.



## OpenAPI

````yaml /openapi.yaml post /api/v1/segments/export.csv
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/segments/export.csv:
    post:
      tags:
        - Segments
      summary: Export an ad-hoc audience as CSV
      description: >-
        Resolve an ad-hoc audience — an unsaved segment filter AST, the same
        shape the segment builder and `POST /api/v1/segments/auto-suggest`
        produce — live against the tenant's contacts and download the matched
        rows as an RFC-4180 CSV attachment, without first persisting or
        materialising a segment. PII columns (phone, email) honour the caller's
        role + reveal context. Requires the `contacts:write` scope (owner /
        admin / developer). Hard-capped at 50,000 rows; a truncated export sets
        the `X-Export-Truncated: true` response header. The saved-segment
        equivalent is `GET /api/v1/contacts/segments/{id}/export.csv`.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - filters
              properties:
                filters:
                  type: object
                  description: >-
                    The audience definition — the same FilterAst the segment
                    builder and auto-suggest speak (a single condition or a
                    nested AND/OR group). Validated server-side against the
                    field allowlist + depth cap.
                  additionalProperties: true
                limit:
                  type: integer
                  minimum: 1
                  maximum: 50000
                  description: >-
                    Optional row cap below the 50,000-row hard ceiling (e.g. for
                    a quick sample). Clamped server-side.
                filename:
                  type: string
                  maxLength: 120
                  description: >-
                    Optional filename stem for the download. Sanitised so it
                    cannot break the Content-Disposition header.
      responses:
        '200':
          description: >-
            RFC-4180 CSV download (`Content-Disposition: attachment`). One row
            per matched contact, with a header row: contact_id, first_name,
            last_name, email, phone, country_code, lifecycle_stage, tags,
            created_at.
          headers:
            X-Export-Truncated:
              schema:
                type: string
                enum:
                  - 'true'
              description: >-
                Present and set to `true` when the export hit the row cap and
                rows were dropped.
          content:
            text/csv:
              schema:
                type: string
                description: One flat row per matched contact, with a header row.
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_*)

````