TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: '919876543210', // the phone to act with (x-phone)
});
async function main() {
const response = await client.scheduledMessages.listScheduledMessages();
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/message/scheduled' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'x-phone: 919876543210'{
"from": 1,
"to": 20,
"count": 20,
"scheduled_messages": [
{
"scheduled_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "120363000000000000@g.us",
"message_payload": {
"message": "Weekly reminder: submit your report",
"media": {}
},
"scheduled_at": "2026-02-01T09:00:00.000Z",
"is_repeat": true,
"repeat_config": {
"repeat_interval": "week",
"repeat_value": 1,
"repeat_days": [
"monday",
"friday"
],
"repeat_ends": "2026-12-31T00:00:00Z"
},
"status": "scheduled",
"skip_next": false,
"paused_at": null,
"updated_at": null,
"performed_by": "api",
"created_at": "2026-01-15T09:30:00.000Z"
}
]
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"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 Messages
Returns the scheduled messages of the workspace, by next run time. Filter by chat, creator, status and repetition, search the message text, and restrict to a scheduled_at window.
TypeScript
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: '919876543210', // the phone to act with (x-phone)
});
async function main() {
const response = await client.scheduledMessages.listScheduledMessages();
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/message/scheduled' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'x-phone: 919876543210'{
"from": 1,
"to": 20,
"count": 20,
"scheduled_messages": [
{
"scheduled_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "120363000000000000@g.us",
"message_payload": {
"message": "Weekly reminder: submit your report",
"media": {}
},
"scheduled_at": "2026-02-01T09:00:00.000Z",
"is_repeat": true,
"repeat_config": {
"repeat_interval": "week",
"repeat_value": 1,
"repeat_days": [
"monday",
"friday"
],
"repeat_ends": "2026-12-31T00:00:00Z"
},
"status": "scheduled",
"skip_next": false,
"paused_at": null,
"updated_at": null,
"performed_by": "api",
"created_at": "2026-01-15T09:30:00.000Z"
}
]
}{
"code": "UNAUTHORIZED_ERROR",
"message": "Invalid bearer auth token",
"status": 401
}{
"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
Headers
Query Parameters
Response
Paginated list of scheduled messages
Was this page helpful?