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

# Get a bulk reservation's status and items

> Fetch the current state of a bulk number reservation and its held items — status, requested-versus-reserved counts, cost, the 15-minute `expires_at`, and the per-item picks. Poll this while deciding whether to finalize or cancel; the row is inline-expired (status `expired`) once its hold window passes. Org-scoped — a reservation belonging to a sibling subaccount or an unknown id returns 404. Read-only; requires the `numbers:read` scope.



## OpenAPI

````yaml /openapi.yaml get /api/v1/numbers/bulk-reserve/{id}
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/bulk-reserve/{id}:
    get:
      tags:
        - Numbers
      summary: Get a bulk reservation's status and items
      description: >-
        Fetch the current state of a bulk number reservation and its held items
        — status, requested-versus-reserved counts, cost, the 15-minute
        `expires_at`, and the per-item picks. Poll this while deciding whether
        to finalize or cancel; the row is inline-expired (status `expired`) once
        its hold window passes. Org-scoped — a reservation belonging to a
        sibling subaccount or an unknown id returns 404. Read-only; requires the
        `numbers:read` scope.
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
          description: Reservation id returned by `POST /numbers/bulk-reserve`.
      responses:
        '200':
          description: The reservation with its held items.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/NumberReservation'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
        '404':
          $ref: '#/components/responses/StandardError'
components:
  schemas:
    NumberReservation:
      type: object
      description: >-
        A bulk number reservation — a 15-minute hold over a batch of DIDs
        discovered from a filter, then finalized (purchased) or cancelled
        (released). Inbound DID provisioning only (invariant #45).
      properties:
        id:
          type: string
        organization_id:
          type: string
        status:
          type: string
          enum:
            - reserving
            - ready
            - partial
            - failed
            - finalizing
            - finalized
            - cancelled
            - expired
          description: Reservation lifecycle state.
        country_code:
          type: string
        area_code:
          type: string
          nullable: true
        number_type:
          type: string
        quantity:
          type: integer
          description: Requested number of DIDs.
        total_cost_cents:
          type: integer
        succeeded_count:
          type: integer
          description: DIDs successfully purchased at finalize.
        failed_count:
          type: integer
        debited_cents:
          type: integer
        requested_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          description: When the 15-minute hold lapses.
        finalized_at:
          type: string
          format: date-time
          nullable: true
        cancelled_at:
          type: string
          format: date-time
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/NumberReservationItem'
    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
    NumberReservationItem:
      type: object
      description: One held DID within a bulk number reservation.
      properties:
        id:
          type: string
        reservation_id:
          type: string
        phone_number:
          type: string
          description: E.164 number held for this item.
        provider:
          type: string
        provider_row_id:
          type: string
          nullable: true
        country_code:
          type: string
        number_type:
          type: string
          nullable: true
        capabilities:
          type: array
          items:
            type: string
        monthly_cost_cents:
          type: integer
        status:
          type: string
          enum:
            - reserved
            - purchased
            - failed
            - released
        purchased_number_id:
          type: string
          nullable: true
          description: >-
            Owned phone-number record id created on finalize (null until
            purchased).
        error_code:
          type: string
          nullable: true
        error_message:
          type: string
          nullable: true
  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_*)

````