> ## 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 org call-forwarding rules (admin)

> Org owner/admin only. Returns every configured per-user call-forwarding rule in the organization, each annotated with the user's name, email, and last-updated timestamp — for onboarding and offboarding provisioning workflows.



## OpenAPI

````yaml /openapi.yaml get /api/v1/voice/call-forwarding/users
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/voice/call-forwarding/users:
    get:
      tags:
        - Voice
      summary: List org call-forwarding rules (admin)
      description: >-
        Org owner/admin only. Returns every configured per-user call-forwarding
        rule in the organization, each annotated with the user's name, email,
        and last-updated timestamp — for onboarding and offboarding provisioning
        workflows.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                properties:
                  data:
                    type: object
                    required:
                      - users
                    properties:
                      users:
                        type: array
                        items:
                          type: object
                          required:
                            - user_id
                            - mode
                            - destinations
                            - ring_timeout_sec
                            - active_from
                            - active_until
                            - note
                            - reject_anonymous
                          properties:
                            user_id:
                              type: string
                            user_name:
                              type:
                                - 'null'
                                - string
                            user_email:
                              type:
                                - 'null'
                                - string
                            updated_at:
                              type:
                                - 'null'
                                - string
                              format: date-time
                            mode:
                              type: string
                              enum:
                                - none
                                - forward_all
                                - sim_ring
                                - sequential
                                - forward_after_timeout
                              description: >-
                                Call-handling mode. `none` rings the user's own
                                devices only; `forward_all`, `sim_ring`,
                                `sequential`, and `forward_after_timeout` fan
                                out to `destinations`.
                            destinations:
                              type: array
                              maxItems: 5
                              items:
                                type: object
                                required:
                                  - kind
                                  - value
                                additionalProperties: false
                                properties:
                                  kind:
                                    type: string
                                    enum:
                                      - pstn
                                      - sip
                                    description: >-
                                      `pstn` dials an E.164 number; `sip` dials
                                      a `sip:` URI.
                                  value:
                                    type: string
                                    minLength: 1
                                    maxLength: 512
                                    description: >-
                                      An E.164 number when `kind` is `pstn`; a
                                      `sip:`-prefixed URI when `kind` is `sip`.
                                  label:
                                    type: string
                                    maxLength: 64
                                    description: >-
                                      Optional human-readable label for the
                                      destination.
                              description: Ordered forwarding targets (max 5).
                            ring_timeout_sec:
                              type: integer
                              minimum: 5
                              maximum: 120
                              description: >-
                                Seconds to ring before the rule falls through
                                (e.g. to voicemail or the next sequential leg).
                            active_from:
                              type:
                                - 'null'
                                - string
                              format: date-time
                              description: >-
                                ISO-8601 timestamp the rule starts applying, or
                                null for always-on.
                            active_until:
                              type:
                                - 'null'
                                - string
                              format: date-time
                              description: >-
                                ISO-8601 timestamp the rule stops applying, or
                                null for always-on.
                            note:
                              type:
                                - 'null'
                                - string
                              maxLength: 280
                              description: Optional free-text note (max 280 chars).
                            reject_anonymous:
                              type: boolean
                              description: >-
                                When true, inbound legs with a
                                withheld/anonymous caller-id are declined before
                                any fan-out.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
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_*)

````