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.chats.listChatNotifications();
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/chats/notifications' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'x-phone: 919876543210'{
"from": 1,
"to": 20,
"count": 20,
"start_time": "2026-01-01T00:00:00Z",
"end_time": null,
"messages": [
{
"notification_id": "true_120363000000000000@g.us_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_911111111111@c.us_add",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "120363000000000000@g.us",
"author": "911111111111@c.us",
"body": null,
"type": "add",
"recipientids": [
"922222222222@c.us"
],
"id": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"fromMe": true,
"remote": "120363000000000000@g.us",
"serialized": "true_120363000000000000@g.us_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_911111111111@c.us_add"
},
"timestamp": "2026-01-15T09:30:00+00:00",
"unique_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"metadata": null,
"call_metadata": null
}
]
}{
"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
}List All Notifications
Returns group system events (participants added or removed, admin and setting changes) across all chats, newest first.
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.chats.listChatNotifications();
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/chats/notifications' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'x-phone: 919876543210'{
"from": 1,
"to": 20,
"count": 20,
"start_time": "2026-01-01T00:00:00Z",
"end_time": null,
"messages": [
{
"notification_id": "true_120363000000000000@g.us_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_911111111111@c.us_add",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "120363000000000000@g.us",
"author": "911111111111@c.us",
"body": null,
"type": "add",
"recipientids": [
"922222222222@c.us"
],
"id": {
"id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"fromMe": true,
"remote": "120363000000000000@g.us",
"serialized": "true_120363000000000000@g.us_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa_911111111111@c.us_add"
},
"timestamp": "2026-01-15T09:30:00+00:00",
"unique_id": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"metadata": null,
"call_metadata": null
}
]
}{
"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
Your Periskope API token, sent as Authorization: Bearer <token>. Generate one from the Periskope dashboard under Settings → API & Webhooks. API access requires an active Pro or Enterprise plan.
Headers
Optional. Scope results to a single phone: country code + number without symbols or spaces (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). Omit to return data across all phones the API token can access.
"919876543210"
Query Parameters
Number of records to skip before the first returned record. Use together with limit to paginate: page N is offset = N * limit. Defaults to 0.
x >= 00
Maximum number of records to return in one page. Cannot exceed 2000. Defaults to 1000.
1 <= x <= 20001000
Only return records at or after this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision.
"2026-01-01T00:00:00Z"
Only return records at or before this time. Accepts ISO 8601 (e.g. 2026-01-01T00:00:00Z) and common date formats (YYYY-MM-DD, YYYY-MM-DD HH:mm, DD/MM/YYYY). Epoch timestamps are not supported. Compared at minute precision.
"2026-01-31T23:59:00Z"
Case-insensitive substring search across the notification type (and chat_id on the workspace-wide list). Composes with the other filters.
"hello"
Response
Paginated list of notifications, newest first (under the messages key)
1-based index of the first record in this page (offset + 1).
1
1-based index of the last record in this page.
20
Number of records in this page — the length of the messages array, not the total across all pages.
20
Echo of the start_time filter, present only when it was sent.
"2026-01-01T00:00:00Z"
Echo of the end_time filter, present only when it was sent.
The messages in this page.
Show child attributes
Show child attributes
Was this page helpful?