List Whitelisted Numbers | Pinnacle

List all whitelisted test numbers with optional filtering and pagination. Results are sorted by creation date, newest first.

PINNACLE-API-KEYstring

API Key authentication via header

This endpoint expects an object.

pageIndexintegerOptional>=0Defaults to 0

pageSizeintegerOptional1-100Defaults to 20

agentIdstringOptionalformat: "^agent_.*"

Filter whitelisted numbers by agent ID (prefixed with ‘agent_’).

numberstringOptionalformat: "^\+[1-9]\d{1,14}$"

Filter by phone number in E.164 format.

statusenumOptional

Filter by whitelist status.

Returns paginated list of whitelisted numbers.

datalist of objects

hasMoreboolean

countinteger

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.rcs.whitelistedNumbers.list({});
8	}
9	main();