List Scheduled Messages API Reference

Serverhttps://api.pinnacle.sh/

List all scheduled messages 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

"ACTIVE""CANCELLED""FAILED"

scheduleTypestringOptional

Filter by schedule type — "MESSAGE" for individual messages, "BLAST" for bulk sends.

Allowed values

"MESSAGE""BLAST"

contentstringOptional

Search scheduled message 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.schedules.list();

Responses

{  "data": [    {      "id": "msg_sched_abc123",      "sendAt": "2025-03-01T09:00:00Z",      "status": "ACTIVE",      "recurrence": null,      "timezone": "America/New_York",      "endDate": null,      "payload": {        "type": "SMS",        "to": "+14155556789",        "from": "+12125551234",        "text": "Reminder: Your appointment is tomorrow"      },      "createdAt": "2025-02-20T14:00:00Z",      "updatedAt": "2025-02-20T14:00:00Z"    }  ],  "hasMore": false,  "count": 1}

List Scheduled Messages

Request body

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

Try asking

List Scheduled Messages

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`