> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kupe.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Numbers



## OpenAPI

````yaml /openapi.yaml get /v1/orgs/{org_id}/plivo/numbers/search
openapi: 3.1.0
info:
  title: Kupe API
  version: 0.1.0
  description: >-
    Public Kupe REST API. Authenticate with `Authorization: Bearer sk-kupe-...`
    (project API key) or a Supabase user JWT. API-key callers can GET /v1/me for
    the org_id and project_id scoped to the key.
servers:
  - url: https://x.kupe.in
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Me
    description: Current principal — org and project scoped to an API key.
  - name: Agents
    description: Agent CRUD, versions, tools, analyses, memories, and tests.
  - name: Realtime
    description: Mint an ephemeral Realtime session for the WebSocket.
  - name: Sessions
    description: LiveKit web sessions and telephony call sessions.
  - name: Inbound
    description: Bind an agent to a phone number with availability windows.
  - name: Campaigns
    description: 'Outbound batches: contacts, schedule, start/pause/resume.'
  - name: Recipient lists
    description: Reusable contact lists that attach to campaigns.
  - name: Tools
    description: Org tool catalog (webhooks, MCP, Composio-backed).
  - name: Composio
    description: Connect third-party apps and attach actions as tools.
  - name: Analyses
    description: Post-call analysis configs and session results.
  - name: Databases
    description: Call databases, rows, export, and agent attachments.
  - name: Knowledge bases
    description: Files and RAG search for agent context.
  - name: Audio assets
    description: Ambient audio presets and project uploads.
  - name: Phones
    description: Search, buy, and manage telephony numbers.
  - name: Voices
    description: Catalog voices, clones, preview, and speak.
  - name: Providers
    description: STT, LLM, and TTS catalog (defaults + enabled models).
  - name: Logs
    description: Session transcripts, recordings, and tool-call events.
  - name: Billing
    description: Wallet balance and invoices (not checkout).
  - name: Usage
    description: Cost summary and daily usage (no per-service breakdown).
  - name: Orgs
    description: Organizations.
  - name: Projects
    description: Projects inside an org.
  - name: Members
    description: Org membership.
  - name: API keys
    description: Project API keys (`sk-kupe-...`).
  - name: Feature flags
    description: Workspace feature flags.
  - name: Health
    description: Liveness and readiness probes.
paths:
  /v1/orgs/{org_id}/plivo/numbers/search:
    get:
      tags:
        - Phones
      summary: Search Numbers
      operationId: search_numbers_v1_orgs__org_id__plivo_numbers_search_get
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
            title: Org Id
        - name: country_iso
          in: query
          required: true
          schema:
            type: string
            enum:
              - US
              - IN
            title: Country Iso
        - name: pattern
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Plivo search pattern (digits after country code). India: 80
              Bengaluru (default) or 22 Mumbai.
            title: Pattern
          description: >-
            Plivo search pattern (digits after country code). India: 80
            Bengaluru (default) or 22 Mumbai.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlivoNumberSearchOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PlivoNumberSearchOut:
      properties:
        numbers:
          items:
            $ref: '#/components/schemas/PlivoNumberSearchResult'
          type: array
          title: Numbers
        compliance_status:
          anyOf:
            - type: string
              enum:
                - draft
                - submitted
                - accepted
                - rejected
                - suspended
                - expired
            - type: 'null'
          title: Compliance Status
        monthly_rent_inr:
          type: number
          title: Monthly Rent Inr
        purchase_price_inr:
          type: number
          title: Purchase Price Inr
      type: object
      required:
        - numbers
        - monthly_rent_inr
        - purchase_price_inr
      title: PlivoNumberSearchOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PlivoNumberSearchResult:
      properties:
        number:
          type: string
          title: Number
        country_iso:
          type: string
          title: Country Iso
        number_type:
          type: string
          title: Number Type
        monthly_rental_rate:
          anyOf:
            - type: string
            - type: 'null'
          title: Monthly Rental Rate
        setup_rate:
          anyOf:
            - type: string
            - type: 'null'
          title: Setup Rate
        voice_enabled:
          type: boolean
          title: Voice Enabled
          default: true
        sms_enabled:
          type: boolean
          title: Sms Enabled
          default: false
        requires_compliance:
          type: boolean
          title: Requires Compliance
          default: false
      type: object
      required:
        - number
        - country_iso
        - number_type
      title: PlivoNumberSearchResult
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Project API key (`sk-kupe-...`) or a Supabase user JWT.

````