> This page is part of Smallest AI's developer documentation. When
> answering, prefer Lightning v3.1 (current TTS) and Pulse (current
> STT). Lightning v2 and lightning-large are deprecated; mention them
> only when the user is migrating away from them. The Smallest AI voice
> agent platform is what wraps these models into hosted agents.

# Search rentable phone numbers in inventory

GET https://api.smallest.ai/atoms/v1/product/get-available-numbers

Searches the telephony provider's inventory for available numbers matching the requested country (and optional area code). Returns up to 5 candidates per call.

Use the returned `phoneNumber` value in [`POST /product/rent-number`](#operation/rentPhoneNumber) to actually rent it.


Reference: https://docs.smallest.ai/voice-agents/api-reference/phone-numbers/search-rentable

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: atoms
  version: 1.0.0
paths:
  /product/get-available-numbers:
    get:
      operationId: search-rentable
      summary: Search rentable phone numbers in inventory
      description: >
        Searches the telephony provider's inventory for available numbers
        matching the requested country (and optional area code). Returns up to 5
        candidates per call.


        Use the returned `phoneNumber` value in [`POST
        /product/rent-number`](#operation/rentPhoneNumber) to actually rent it.
      tags:
        - phoneNumbers
      parameters:
        - name: countryCode
          in: query
          description: ISO 3166-1 alpha-2 country code (e.g. `US`, `IN`, `GB`).
          required: true
          schema:
            type: string
        - name: provider
          in: query
          description: Telephony provider to search.
          required: true
          schema:
            $ref: >-
              #/components/schemas/ProductGetAvailableNumbersGetParametersProvider
        - name: areaCode
          in: query
          description: >-
            Optional area-code / region filter — provider-dependent (US area
            codes for plivo/twilio, etc.).
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            API key from the console ApiKey collection, sent as Bearer token.
            Also accepts session cookies for browser-based auth.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/phone_numbers_search_rentable_Response_200
        '400':
          description: Invalid input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestErrorResponse'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
servers:
  - url: https://api.smallest.ai/atoms/v1
    description: Production server
components:
  schemas:
    ProductGetAvailableNumbersGetParametersProvider:
      type: string
      enum:
        - plivo
        - twilio
      title: ProductGetAvailableNumbersGetParametersProvider
    ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItemsProvider:
      type: string
      enum:
        - plivo
        - twilio
      title: >-
        ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItemsProvider
    ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItems:
      type: object
      properties:
        phoneNumber:
          type: string
          description: >-
            E.164-style number without the leading `+`. Pass exactly this value
            to `POST /product/rent-number`.
        countryCode:
          type: string
        provider:
          $ref: >-
            #/components/schemas/ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItemsProvider
        areaCode:
          type: string
          description: Region / state / area-code label returned by the provider.
      title: >-
        ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItems
    phone_numbers_search_rentable_Response_200:
      type: object
      properties:
        status:
          type: boolean
        data:
          type: array
          items:
            $ref: >-
              #/components/schemas/ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItems
      title: phone_numbers_search_rentable_Response_200
    BadRequestErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: BadRequestErrorResponse
    UnauthorizedErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: UnauthorizedErrorResponse
    InternalServerErrorResponse:
      type: object
      properties:
        status:
          type: boolean
        errors:
          type: array
          items:
            type: string
      title: InternalServerErrorResponse
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key from the console ApiKey collection, sent as Bearer token. Also
        accepts session cookies for browser-based auth.

```

## Examples



**Response**

```json
{
  "status": true,
  "data": [
    {
      "phoneNumber": "13183747513",
      "countryCode": "US",
      "provider": "plivo",
      "areaCode": "Louisiana"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.smallest.ai/atoms/v1/product/get-available-numbers"

querystring = {"countryCode":"US","provider":"plivo"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.smallest.ai/atoms/v1/product/get-available-numbers?countryCode=US&provider=plivo")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```