> ## 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 the number inventory as CSV or JSON

> Download the organization's full owned-DID inventory as a single CSV (default) or JSON file for finance reconciliation and bulk auditing — the same rows the dashboard Numbers list shows, plus a trailing-30-day realised spend column per number. Use it to reconcile the monthly DID line without paging the list API. Filter with `status`, `country_code`, and `search`; CSV timestamps localise to the `tz`/`locale` you pass. Capped at 50,000 rows, with the `X-Truncated` header set when a larger inventory is truncated. Read-only; requires the `numbers:read` scope. Inbound DID provisioning only (invariant #45 untouched).



## OpenAPI

````yaml /openapi.yaml get /api/v1/numbers/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
  - name: Risk
    description: >-
      Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
      URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
      composite verdict queryable before a send or a call.
  - name: Orby
    description: >-
      In-dashboard Orby operator assistant: streamed assistant turns,
      conversation threads, product knowledge-base search, and the tool-action
      approval gate. Available to signed-in operators only (dashboard session
      auth — API-key requests are rejected).
paths:
  /api/v1/numbers/export:
    get:
      tags:
        - Numbers
      summary: Export the number inventory as CSV or JSON
      description: >-
        Download the organization's full owned-DID inventory as a single CSV
        (default) or JSON file for finance reconciliation and bulk auditing —
        the same rows the dashboard Numbers list shows, plus a trailing-30-day
        realised spend column per number. Use it to reconcile the monthly DID
        line without paging the list API. Filter with `status`, `country_code`,
        and `search`; CSV timestamps localise to the `tz`/`locale` you pass.
        Capped at 50,000 rows, with the `X-Truncated` header set when a larger
        inventory is truncated. Read-only; requires the `numbers:read` scope.
        Inbound DID provisioning only (invariant #45 untouched).
      parameters:
        - in: query
          name: format
          required: false
          schema:
            type: string
            enum:
              - csv
              - json
            default: csv
          description: Output format — a CSV attachment (default) or a JSON array.
        - in: query
          name: status
          required: false
          schema:
            type: string
          description: >-
            Status filter (e.g. `active`); defaults to `all` so
            released/parked-but-still-billable rows are included.
        - in: query
          name: country_code
          required: false
          schema:
            type: string
          description: ISO 3166-1 alpha-2 country filter.
        - in: query
          name: search
          required: false
          schema:
            type: string
          description: Free-text match on the phone number or label.
        - in: query
          name: tz
          required: false
          schema:
            type: string
          description: >-
            IANA timezone for CSV timestamp columns (e.g. `Europe/Istanbul`);
            JSON stays canonical UTC.
        - in: query
          name: locale
          required: false
          schema:
            type: string
          description: BCP-47 locale for CSV date formatting (defaults to `en-US`).
      responses:
        '200':
          description: >-
            The inventory export as a downloadable attachment. `X-Row-Count`
            carries the row count and `X-Truncated` is set when the 50,000-row
            cap was hit.
          content:
            text/csv:
              schema:
                type: string
              example: >
                msisdn,country_code,area_code,status,number_type,capabilities,label,tags,forwarding_number,assigned_to,compliance_profile_id,tfv_status,monthly_cost,created_at,assigned_at,next_billing_at,spend_30d

                +14155550100,US,415,active,local,"sms,voice",Support
                line,,,,,,1.00,2026-08-01T00:00:00Z,2026-08-01T00:00:00Z,2026-09-01T00:00:00Z,3.45
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
              example:
                - msisdn: '+14155550100'
                  country_code: US
                  status: active
                  number_type: local
                  capabilities: sms,voice
                  monthly_cost: 1
                  spend_30d: 3.45
        '422':
          $ref: '#/components/responses/StandardError'
components:
  responses:
    StandardError:
      description: >-
        Standard error envelope. `error.code` is machine-readable; see the
        [error reference](https://docs.orbit.devotel.io/reference/error-codes)
        for the catalogue.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                required:
                  - code
                  - message
                  - status
                properties:
                  code:
                    type: string
                    description: Machine-readable error code (e.g. INVALID_PHONE_NUMBER)
                  message:
                    type: string
                    description: Human-readable error description
                  status:
                    type: integer
                    description: HTTP status code
                  details:
                    type: object
                    additionalProperties: true
                    description: Additional context about the error
              meta:
                type: object
                properties:
                  request_id:
                    type: string
                  timestamp:
                    type: string
                    format: date-time
                  docs_url:
                    type: string
                    format: uri
                    description: Link to relevant error documentation
  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_*)

````