List Whitelisted Numbers API Reference

Serverhttps://api.pinnacle.sh/

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

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

pageIndexintegerOptional

Range

0 <= value

Default

pageSizeintegerOptional

Range

1 <= value <= 100

Default

agentIdstringOptional

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

Match

^agent_.*

Example

"agent_pinnacle"

numberstringOptional

Filter by phone number in E.164 format.

Match

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

Example

"+14155550142"

statusstringOptional

Filter by whitelist status.

Allowed values

"ACCEPTED""REJECTED""PENDING"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.rcs.whitelistedNumbers.list();

Responses

{  "data": [    {      "number": "+12125551234",      "status": "ACCEPTED",      "agentId": "agent_abc123",      "createdAt": "2025-01-15T10:30:00Z"    },    {      "number": "+14155556789",      "status": "PENDING",      "agentId": "agent_abc123",      "createdAt": "2025-02-01T12:00:00Z"    }  ],  "hasMore": false,  "count": 2}

List Whitelisted Numbers

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Whitelisted Numbers

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`