List Toll-Free Campaigns API Reference

Serverhttps://api.pinnacle.sh/

List all toll-free campaigns 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

statusstringOptional

Allowed values

"INCOMPLETE""IN REVIEW""VERIFIED""FAILED"

brandIdstringOptional

Example

"resource_01J8K3R7M9"

namestringOptional

Filter by campaign name (partial match, case-insensitive).

Example

"Acme Support"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.campaigns.tollFree.list();

Responses

{  "data": [    {      "campaignId": "tf_abc123",      "name": "Support Line",      "status": "VERIFIED",      "brandId": "brand_abc123",      "useCase": "CUSTOMER_CARE",      "createdAt": "2025-01-15T10:30:00Z",      "updatedAt": "2025-02-20T14:00:00Z"    }  ],  "hasMore": false,  "count": 1}

List Toll-Free Campaigns

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Toll-Free Campaigns

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`