List Blasts API Reference

Serverhttps://api.pinnacle.sh/

List all blasts 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

audienceIdstringOptional

Filter blasts by audience ID.

Example

"aud_01J8K3R7M9"

senderstringOptional

Filter blasts that include this sender (phone number or agent ID).

Example

"agent_pinnacle"

contentstringOptional

Search blast content (partial match, case-insensitive).

Example

"Hello from Pinnacle!"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

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

await client.messages.blasts.list();

Responses

{  "data": [    {      "id": "blast_abc123",      "audienceId": "aud_abc123",      "type": "SMS",      "senders": [        "+12125551234"      ],      "content": {        "text": "Flash sale — 20% off everything today!"      },      "options": null,      "fallback": null,      "createdAt": "2025-01-15T10:30:00Z"    }  ],  "hasMore": false,  "count": 1}

List Blasts

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Blasts

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

500application/json

Example SMS Blast

Example RCS Blast with Fallback

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`