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

# Fleet rollup across the SIM estate

> Roll the org's SIMs up into fleets (grouped by `fleetId`, with SIMs that carry none collapsed under `ungrouped`).



## OpenAPI

````yaml /openapi.yaml get /api/v1/numbers/connectivity/fleets
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/numbers/connectivity/fleets:
    get:
      tags:
        - Numbers
      summary: Fleet rollup across the SIM estate
      description: >-
        Roll the org's SIMs up into fleets (grouped by `fleetId`, with SIMs that
        carry none collapsed under `ungrouped`).
      responses:
        '200':
          description: Fleet rollup
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      fleets:
                        type: array
                        items:
                          $ref: '#/components/schemas/ConnectivityFleetSummary'
                      count:
                        type: integer
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
components:
  schemas:
    ConnectivityFleetSummary:
      type: object
      description: >-
        A fleet rollup row grouping SIMs by `fleetId` (`ungrouped` collects SIMs
        with no fleet).
      required:
        - fleetId
        - simCount
        - activeCount
        - suspendedCount
        - terminatedCount
        - totalUsageBytes
      properties:
        fleetId:
          type: string
        simCount:
          type: integer
        activeCount:
          type: integer
        suspendedCount:
          type: integer
        terminatedCount:
          type: integer
        totalUsageBytes:
          type: integer
          description: Sum of cumulative usageBytes across the fleet's SIMs.
        pool:
          allOf:
            - $ref: '#/components/schemas/ConnectivityDataPool'
          nullable: true
          description: >-
            Shared data-pool rollup for the fleet's SIMs on a `pooled` plan, or
            null when the fleet has no pooled SIMs.
    ResponseMeta:
      type: object
      required:
        - request_id
        - timestamp
      additionalProperties: false
      properties:
        request_id:
          type: string
          description: Unique request identifier (also returned as X-Request-Id header)
        timestamp:
          type: string
          format: date-time
        docs_url:
          type: string
          format: uri
          nullable: true
    ConnectivityDataPool:
      type: object
      description: >-
        Aggregate health of a fleet's SHARED data pool — the combined allowance
        of its pooled-plan SIMs and how much of it has been consumed.
        Descriptive rollup only (not billed here).
      required:
        - pooledSimCount
        - allowanceBytes
        - usageBytes
        - remainingBytes
        - usagePct
        - status
      properties:
        pooledSimCount:
          type: integer
          description: Live (non-terminated) SIMs on a pooled plan backing this pool.
        allowanceBytes:
          type: integer
          description: Total shared allowance across those SIMs, in bytes.
        usageBytes:
          type: integer
          description: Aggregate usage drawn from the pool, in bytes.
        remainingBytes:
          type: integer
          description: Allowance still available (never negative), in bytes.
        usagePct:
          type: integer
          description: >-
            Usage as a whole-number percentage of the allowance (can exceed
            100).
        status:
          type: string
          enum:
            - ok
            - warning
            - exceeded
          description: >-
            `ok` under the warning threshold; `warning` at/over it but within
            allowance; `exceeded` once usage meets or passes the allowance
            (overage).
  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_*)

````