Search available Telnyx phone numbers for authenticated users

GET

/api/phone_numbers/available

const url = 'https://example.com/api/phone_numbers/available';
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);
}

curl --request GET \
  --url https://example.com/api/phone_numbers/available \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Query Parameters

area_code

string

state

string

Responses

200

Available phone numbers search results

application/json

Array<object>

object

phone_number

string

national_destination_code

string

monthly_cost

string

upfront_cost

string

currency

string

is_owned_pool

boolean

Example

[
  {
    "monthly_cost": "1.00",
    "upfront_cost": "1.00",
    "currency": "USD",
    "is_owned_pool": false
  }
]

401

Unauthorized

403

Forbidden