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

# Search available phone numbers at Papers retail prices

> Requires an activated Telnyx account; otherwise returns 503. Required scope: numbers:read.



## OpenAPI

````yaml /openapi.json get /phone-numbers/available
openapi: 3.1.0
info:
  title: Papers API
  version: 0.1.0
  description: >-
    Email, SMS, and workspace resources for Papers. Authenticate resource
    requests with a scoped API key or OAuth token. Administrative endpoints
    require a human session.
servers:
  - url: https://www.papers.bot/v1
security:
  - bearerAuth: []
paths:
  /phone-numbers/available:
    get:
      tags:
        - Phone numbers
      summary: Search available phone numbers at Papers retail prices
      description: >-
        Requires an activated Telnyx account; otherwise returns 503. Required
        scope: numbers:read.
      operationId: searchPhoneNumbers
      parameters:
        - name: country
          in: query
          schema:
            type: string
            pattern: ^[A-Z]{2}$
            default: US
      responses:
        '200':
          description: Successful JSON response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AvailableNumberResults'
        '429':
          description: >-
            Request rate limit or communication quota exceeded. Rate-limit
            responses include Retry-After.
          headers:
            Retry-After:
              description: >-
                Seconds until the request-rate window resets (rate_limited
                errors)
              schema:
                type: integer
                minimum: 1
                maximum: 60
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        default:
          description: Request rejected
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    AvailableNumberResults:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              phone_number:
                type: string
              phone_number_type:
                type: string
              cost_information:
                type: object
                properties:
                  upfront_cost:
                    type: string
                    pattern: ^\d+(\.\d+)?$
                    description: Papers retail price as an exact decimal string.
                  monthly_cost:
                    type: string
                    pattern: ^\d+(\.\d+)?$
                    description: Recurring monthly rental price as an exact decimal string.
                  currency:
                    type: string
                required:
                  - upfront_cost
                  - monthly_cost
                  - currency
                additionalProperties: false
              features:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                  required:
                    - name
                  additionalProperties: false
              region_information:
                type: array
                items:
                  type: object
                  properties:
                    region_name:
                      type: string
                    region_type:
                      type: string
                  required:
                    - region_name
                    - region_type
                  additionalProperties: false
            required:
              - phone_number
              - cost_information
              - features
            additionalProperties: false
      required:
        - data
      additionalProperties: false
    Error:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            request_id:
              type: string
            retryable:
              type: boolean
            details:
              anyOf:
                - type: object
                  properties:
                    approvalId:
                      type: string
                      minLength: 1
                  required:
                    - approvalId
                  additionalProperties: false
                - type: array
                  items:
                    type: object
                    properties:
                      code:
                        type: string
                      path:
                        type: array
                        items:
                          type:
                            - string
                            - number
                      message:
                        type: string
                    required:
                      - code
                      - path
                      - message
                    additionalProperties: false
          required:
            - code
            - message
            - request_id
            - retryable
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Workspace API key or delegated OAuth access token with /v1 resource
        audience. Administrative routes require the Better Auth browser session
        instead.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.