API ReferenceRCS Agents

List Whitelisted Numbers

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

Authentication

PINNACLE-API-KEYstring
API Key authentication via header

Request

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.
Allowed values:

Response

Returns paginated list of whitelisted numbers.
datalist of objects
hasMoreboolean
countinteger

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error