Search for Available Phone Numbers

Search for available phone numbers that match your exact criteria.

This endpoint expects an object.

typelist of enumsRequired

Types of phone numbers to return in your search.

Allowed values:

featureslist of enumsOptional

locationobjectOptional

Filter your search by geographic location to find numbers in specific regions.

Toll-free numbers ignore city and state filters.

numberobjectOptional

Filter your search by digit pattern.

optionsobjectOptional

Extra search settings to control how many results you get.

Returns a list of available phone numbers that match the search criteria.

Use our buy endpoint to purchase any amount of phone numbers that you like.

numberstring

Phone number in E.164 format.

phone_typeenum

Classification that defines the number's billing model and geographic scope.

Allowed values:

costobject

Pricing details for the phone number.

featureslist of enums

Supported communication capabilities associated with the number.

regionobject

Geographic and routing information for the phone number.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.phoneNumbers.search({});
8	}
9	main();

1	[
2	{
3	"number": "+13324557514",
4	"phone_type": "LOCAL",
5	"cost": {
6	"monthly": 1.15,
7	"upfront": 1.15,
8	"currency": "USD"
9	},
10	"features": [
11	"HD_VOICE",
12	"VOICE",
13	"EMERGENCY",
14	"FAX",
15	"MMS",
16	"SMS"
17	],
18	"region": {
19	"country": "US",
20	"state": "NY",
21	"city": "NEW YORK CITY",
22	"rateCenter": "NEW YORK CITY ZONE 01"
23	}
24	}
25	]