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

# Search available numbers

> List phone numbers available to buy.



## OpenAPI

````yaml /en/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/available
openapi: 3.0.3
info:
  title: Notifique API. Números de Telefone
  description: >-
    API para **consultar números de telefone** do workspace, **buscar números
    disponíveis** para contratação e **configurar o comportamento de chamadas
    recebidas**.


    A **contratação** (reserva e pagamento) é feita pelo **painel** do
    Notifique. Use estes endpoints para integrações de consulta e configuração.


    **Autenticação:** cabeçalho `Authorization: Bearer sk_live_xxxxx` ou
    `x-api-key: sk_live_xxxxx`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Production
security:
  - ntfPhoneBearerAuth: []
  - ntfPhoneApiKeyHeader: []
tags:
  - name: Números de Telefone
    description: Listar, consultar, buscar disponíveis e configurar voz de entrada.
paths:
  /v1/phone-numbers/available:
    get:
      tags:
        - Números de Telefone
      summary: Search available numbers
      description: List phone numbers available to buy.
      operationId: ntfPhone_getV1PhoneNumbersAvailable
      parameters:
        - name: countryCode
          in: query
          description: Código ISO do país (padrão `US`).
          schema:
            type: string
            example: BR
        - name: phoneNumberType
          in: query
          description: 'Tipo do número (ex.: `local`, `mobile`, `toll_free`).'
          schema:
            type: string
        - name: areaCode
          in: query
          description: DDD ou código de área (national destination code).
          schema:
            type: string
            example: '11'
        - name: contains
          in: query
          description: Sequência de dígitos que o número deve conter.
          schema:
            type: string
      responses:
        '200':
          description: Lista de números disponíveis com preço mensal em centavos (BRL).
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/NtfPhone_AvailableNumber'
              example:
                success: true
                data:
                  - phoneE164: '+5511987654321'
                    countryCode: BR
                    phoneNumberType: local
                    features:
                      - voice
                      - sms
                    region: SP
                    locality: São Paulo
                    monthlyPriceBrlCents: 2990
        '401':
          $ref: '#/components/responses/NtfPhone_Unauthorized'
        '403':
          $ref: '#/components/responses/NtfPhone_Forbidden'
        '502':
          description: Erro temporário ao consultar catálogo.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfPhone_ErrorEnvelope'
components:
  schemas:
    NtfPhone_AvailableNumber:
      type: object
      properties:
        phoneE164:
          type: string
        countryCode:
          type: string
        phoneNumberType:
          type: string
        features:
          type: array
          items:
            type: string
        region:
          type: string
          nullable: true
        locality:
          type: string
          nullable: true
        monthlyPriceBrlCents:
          type: integer
    NtfPhone_ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        message:
          type: string
  responses:
    NtfPhone_Unauthorized:
      description: Missing or invalid API Key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPhone_ErrorEnvelope'
          example:
            success: false
            error: Unauthorized
            message: Unauthorized
            code: UNAUTHORIZED
    NtfPhone_Forbidden:
      description: Escopo insuficiente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPhone_ErrorEnvelope'
          example:
            success: false
            error: Forbidden
            message: 'Missing scope: phone_numbers:read'
            code: FORBIDDEN
  securitySchemes:
    ntfPhoneBearerAuth:
      type: http
      scheme: bearer
      description: 'API Key no formato Bearer (ex.: sk_live_...).'
    ntfPhoneApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key alternativa ao Bearer.

````