> 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/api-reference/voice-agents/phone-numbers/search-rentable

## Authentication

- `Authorization` header (bearer token, required) — API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

## Request

### Query parameters

- `countryCode` (string, required) — ISO 3166-1 alpha-2 country code (e.g. `US`, `IN`, `GB`).
- `provider` (enum, required) — Telephony provider to search.
  - Allowed values: `twilio`, `plivo`
- `areaCode` (string, optional) — Optional area-code / region filter — provider-dependent (US area codes for plivo/twilio, etc.).

## Response

### 200

Successful response

- `status` (boolean, optional)
- `data` (list of ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItems, optional)

## Errors

### 400 Bad Request Error

Invalid input

- `status` (boolean, optional)
- `errors` (list of string, optional)

### 401 Unauthorized Error

Unauthorized access

- `status` (boolean, optional)
- `errors` (list of string, optional)

### 500 Internal Server Error

Internal server error

- `status` (boolean, optional)
- `errors` (list of string, optional)

## Types

### ProductGetAvailableNumbersGetResponsesContentApplicationJsonSchemaDataItems

- `phoneNumber` (string, optional) — E.164-style number without the leading `+`. Pass exactly this value to `POST /product/rent-number`.
- `countryCode` (string, optional)
- `provider` (enum, optional)
  - Allowed values: `twilio`, `plivo`
- `areaCode` (string, optional) — Region / state / area-code label returned by the provider.

## 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":"twilio"}

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=twilio';
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=twilio"

	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=twilio")

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=twilio")
  .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=twilio', [
  '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=twilio");
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=twilio")! 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()
```