Skip to main content
GET
/
api
/
team
/
assets
/
available_phone_numbers
JavaScript
import BrainbaseLabs from 'brainbase-labs';

const client = new BrainbaseLabs({
  apiKey: process.env['BRAINBASE_LABS_API_KEY'], // This is the default and can be omitted
});

await client.team.assets.listAvailablePhoneNumbers({
  countryCode: 'countryCode',
  numberType: 'Local',
});
import os
from brainbase_labs import BrainbaseLabs

client = BrainbaseLabs(
api_key=os.environ.get("BRAINBASE_LABS_API_KEY"), # This is the default and can be omitted
)
client.team.assets.list_available_phone_numbers(
country_code="countryCode",
number_type="Local",
)
curl --request GET \
--url https://brainbase-monorepo-api.onrender.com/api/team/assets/available_phone_numbers \
--header 'x-api-key: <api-key>'
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://brainbase-monorepo-api.onrender.com/api/team/assets/available_phone_numbers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://brainbase-monorepo-api.onrender.com/api/team/assets/available_phone_numbers"

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

req.Header.Add("x-api-key", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://brainbase-monorepo-api.onrender.com/api/team/assets/available_phone_numbers")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://brainbase-monorepo-api.onrender.com/api/team/assets/available_phone_numbers")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

Authorizations

x-api-key
string
header
required

API key authentication

Query Parameters

countryCode
string
required

Two-letter ISO country code (e.g. US, GB).

numberType
enum<string>
required

Type of phone number.

Available options:
Local,
Mobile,
TollFree
areaCode
string

Filter by area code.

contains
string

Filter by pattern contained in number.

smsEnabled
boolean

Filter for SMS-enabled numbers.

voiceEnabled
boolean

Filter for voice-enabled numbers.

mmsEnabled
boolean

Filter for MMS-enabled numbers.

Response

List of available phone numbers.