> ## 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 phone numbers

> List the organization's owned phone numbers (DIDs), newest first, with keyset pagination. Filter by lifecycle `status`, a free-text `search` over the E.164 number and label, or one or more `tags`; each row is enriched with a passively-derived `liveness` state so the inventory table can flag numbers that have stopped receiving inbound traffic. Pass `?fields=id,phone_number,status` for a slim projection suited to lightweight sender-id pickers. Org-scoped and read-only.



## OpenAPI

````yaml /openapi.yaml get /api/v1/numbers/
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/:
    get:
      tags:
        - Numbers
      summary: List phone numbers
      description: >-
        List the organization's owned phone numbers (DIDs), newest first, with
        keyset pagination. Filter by lifecycle `status`, a free-text `search`
        over the E.164 number and label, or one or more `tags`; each row is
        enriched with a passively-derived `liveness` state so the inventory
        table can flag numbers that have stopped receiving inbound traffic. Pass
        `?fields=id,phone_number,status` for a slim projection suited to
        lightweight sender-id pickers. Org-scoped and read-only.
      parameters:
        - in: query
          name: status
          required: false
          schema:
            type: string
          description: >-
            Filter by lifecycle status (e.g. `active`, `pending_compliance`,
            `released`, `suspended`).
        - in: query
          name: search
          required: false
          schema:
            type: string
          description: Free-text match against the E.164 number and label.
        - in: query
          name: tags
          required: false
          schema:
            type: string
          description: >-
            Comma-separated tag slugs; a row matching any supplied tag is
            returned.
        - in: query
          name: limit
          required: false
          schema:
            type: integer
            minimum: 1
          description: >-
            Page size, most-recent first. Clamped server-side to the max page
            size.
        - in: query
          name: cursor
          required: false
          schema:
            type: string
          description: >-
            Opaque keyset cursor from the previous page's
            `meta.pagination.cursor`.
        - in: query
          name: fields
          required: false
          schema:
            type: string
          description: >-
            Optional comma-separated slim projection (e.g.
            `id,phone_number,status`).
      responses:
        '200':
          description: A page of the organization's owned phone numbers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PhoneNumberList'
components:
  schemas:
    PhoneNumberList:
      type: object
      required:
        - data
        - meta
      additionalProperties: false
      properties:
        data:
          type: array
          items:
            type: object
            required:
              - id
              - phone_number
              - status
              - created_at
            additionalProperties: false
            properties:
              id:
                type: string
              tenant_id:
                type: string
              phone_number:
                type: string
                description: E.164 formatted
              country_code:
                type: string
              capabilities:
                type: array
                items:
                  type: string
                  enum:
                    - voice
                    - sms
                    - mms
                    - fax
              type:
                type: string
                enum:
                  - local
                  - mobile
                  - tollfree
                  - shortcode
                  - ucan
              provider:
                type: string
                enum:
                  - telnyx
                  - didww
                  - platform
              provider_order_id:
                type: string
                nullable: true
              status:
                type: string
                enum:
                  - pending_compliance
                  - active
                  - released
                  - porting_in
                  - porting_out
                  - suspended
              voice_application_sid:
                type: string
                nullable: true
              sms_application_sid:
                type: string
                nullable: true
              monthly_cost_cents:
                type: integer
              setup_cost_cents:
                type: integer
                nullable: true
              created_at:
                type: string
                format: date-time
              updated_at:
                type: string
                format: date-time
        meta:
          type: object
          additionalProperties: false
          properties:
            request_id:
              type: string
              description: Unique request identifier (also returned as X-Request-Id header)
            timestamp:
              type: string
              format: date-time
            pagination:
              type: object
              required:
                - has_more
              additionalProperties: false
              properties:
                cursor:
                  type: string
                  nullable: true
                has_more:
                  type: boolean
                total:
                  type: integer
                  nullable: true
  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_*)

````