TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
});
async function main() {
const response = await client.scheduledMessages.listScheduledMessageOccurrences({
scheduled_id: '00000000-0000-0000-0000-000000000000',
});
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/message/scheduled/00000000-0000-0000-0000-000000000000/occurrences' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"from": 1,
"to": 20,
"count": 20,
"occurrences": [
{
"id": "00000000-0000-0000-0000-000000000000",
"scheduled_id": "00000000-0000-0000-0000-000000000000",
"chat_id": "120363000000000000@g.us",
"sent_message_id": "00000000-0000-0000-0000-000000000000",
"message_id": null,
"is_success": true,
"remarks": null,
"delivered_at": null,
"created_at": "2026-01-15T09:30:00.000Z"
}
]
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "NOT_FOUND_ERROR",
"message": "Scheduled message not found",
"status": 404
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Scheduled Message APIs
List Scheduled Message Runs
Returns the run history of a scheduled message, newest first — each run records whether it sent, failed or was skipped, and the resulting message id.
TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
});
async function main() {
const response = await client.scheduledMessages.listScheduledMessageOccurrences({
scheduled_id: '00000000-0000-0000-0000-000000000000',
});
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/message/scheduled/00000000-0000-0000-0000-000000000000/occurrences' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"from": 1,
"to": 20,
"count": 20,
"occurrences": [
{
"id": "00000000-0000-0000-0000-000000000000",
"scheduled_id": "00000000-0000-0000-0000-000000000000",
"chat_id": "120363000000000000@g.us",
"sent_message_id": "00000000-0000-0000-0000-000000000000",
"message_id": null,
"is_success": true,
"remarks": null,
"delivered_at": null,
"created_at": "2026-01-15T09:30:00.000Z"
}
]
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"code": "NOT_FOUND_ERROR",
"message": "Scheduled message not found",
"status": 404
}{
"code": "VALIDATION_ERROR",
"message": "Request validation failed",
"status": 422,
"fields": {
"body.chat_id": {
"message": "chat_id is required"
}
}
}{
"code": "RATE_LIMIT_ERROR",
"message": "You can only make 100 requests per second",
"status": 429
}{
"code": "UNKNOWN_ERROR",
"message": "Internal server error",
"status": 500
}Authorizations
Path Parameters
Query Parameters
Response
Paginated list of runs, newest first
Was this page helpful?