---
title: "List Scheduled Messages"
method: POST
path: "/messages/schedules/list"
tags: ["Messages > schedules"]
---

# List Scheduled Messages

`POST /messages/schedules/list`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/messages/schedules/list`
- Auth: API key in header `PINNACLE-API-KEY`

List all scheduled messages with optional filtering and pagination. Results are sorted by creation date, newest first.

## Request body

- ListScheduledMessagesRequest
  - `pageIndex` integer
  - `pageSize` integer
  - `status` 'ACTIVE' | 'CANCELLED' | 'FAILED'
  - `scheduleType` 'MESSAGE' | 'BLAST': Filter by schedule type — "MESSAGE" for individual messages, "BLAST" for bulk sends.
  - `content` string: Search scheduled message content (partial match, case-insensitive).

## Response `200`

Returns paginated list of scheduled messages.

- ListScheduledMessagesResponse
  - `data` ScheduledMessageSummary[], required
    - `id` string, required: Unique identifier for the scheduled message.
    - `sendAt` string, nullable, required: ISO 8601 timestamp of when the message is scheduled to be sent.
    - `status` 'ACTIVE' | 'CANCELLED' | 'FAILED', required: Current status of the scheduled message.
    - `recurrence` string, nullable, required: Cron expression for recurring schedules.
    - `timezone` string, nullable, required: Timezone for the schedule (e.g. "America/New_York").
    - `endDate` string, nullable, required: ISO 8601 end date for recurring schedules.
    - `payload` ScheduledMessageSummaryPayload, required: The scheduled message payload.
    - `createdAt` string, required: ISO 8601 timestamp of when the schedule was created.
    - `updatedAt` string, required: ISO 8601 timestamp of when the schedule was last updated.
  - `hasMore` boolean, required
  - `count` integer, required

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)
