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

# Search Available Numbers



## OpenAPI

````yaml /openapi/openapi.yaml get /v1/phone-numbers/search
openapi: 3.1.0
info:
  title: OneInbox API
  version: 1.0.0
servers:
  - url: https://api-tokyo.oneinbox.ai
    description: Production (Tokyo ap-northeast-1)
security: []
tags:
  - name: health
  - name: integrations
  - name: llm-models
  - name: tools
  - name: knowledge-bases
  - name: voices
  - name: webhooks
  - name: agents
  - name: phone-numbers
  - name: calls
  - name: workspace
  - name: usage
  - name: audit-events
paths:
  /v1/phone-numbers/search:
    get:
      tags:
        - phone-numbers
      summary: Search Available Numbers
      operationId: search_available_numbers_v1_phone_numbers_search_get
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
            maxLength: 2
            minLength: 2
            title: Country
            default: US
        - name: area_code
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Area code (US/CA)
            title: Area Code
          description: Area code (US/CA)
        - name: contains
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Contains
            description: Digits/letters to match
          description: Digits/letters to match
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 50
            minimum: 1
            default: 20
            title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailablePhoneNumbersResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - API Key: []
components:
  schemas:
    AvailablePhoneNumbersResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AvailablePhoneNumber'
          type: array
          title: Items
      type: object
      required:
        - items
      title: AvailablePhoneNumbersResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AvailablePhoneNumber:
      properties:
        phone_number:
          type: string
          title: Phone Number
        friendly_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Friendly Name
        locality:
          anyOf:
            - type: string
            - type: 'null'
          title: Locality
        region:
          anyOf:
            - type: string
            - type: 'null'
          title: Region
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
        capabilities:
          items:
            type: string
          type: array
          title: Capabilities
      type: object
      required:
        - phone_number
      title: AvailablePhoneNumber
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    API Key:
      type: http
      description: >-
        Your **API key** sent as a Bearer credential — `Authorization: Bearer
        <api_key>`, where `<api_key>` starts with `oi_sk_` (create one via `POST
        /v1/api-keys`). Although the field is labelled 'token', paste your API
        key here. A dashboard JWT is also accepted on this header for the same
        endpoints.
      scheme: bearer

````