import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
});
async function main() {
const response = await client.chats.listChatAuditLogs({
chat_id: '120363000000000000@g.us',
});
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/chats/120363000000000000@g.us/audit-logs' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"from": 1,
"to": 20,
"count": 20,
"logs": [
{
"log_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"chat_id": "120363000000000000@g.us",
"action": "STATUS_CHANGED",
"performed_by": "user@example.com",
"type": "chat",
"old_record": {},
"new_record": {},
"timestamp": "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
}Get Chat Audit Logs
Returns the audit trail of a chat — who changed what and when — newest first. Filter by performed_by and action, and restrict to a timestamp window.
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
});
async function main() {
const response = await client.chats.listChatAuditLogs({
chat_id: '120363000000000000@g.us',
});
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/chats/120363000000000000@g.us/audit-logs' \
-H 'Authorization: Bearer YOUR_API_KEY'{
"from": 1,
"to": 20,
"count": 20,
"logs": [
{
"log_id": "00000000-0000-0000-0000-000000000000",
"org_id": "00000000-0000-0000-0000-000000000000",
"chat_id": "120363000000000000@g.us",
"action": "STATUS_CHANGED",
"performed_by": "user@example.com",
"type": "chat",
"old_record": {},
"new_record": {},
"timestamp": "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
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.
Path Parameters
Unique id of the chat. For 1-1 chats, country code + number optionally suffixed with @c.us (e.g. 922222222222@c.us — the suffix is added automatically when omitted); for groups, the id ending with @g.us.
1"120363000000000000@g.us"
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. Defaults to 1000.
x >= 11000
Only log entries at or after this time (ISO 8601).
"2026-01-01T00:00:00Z"
Only log entries at or before this time (ISO 8601).
"2026-01-31T23:59:00Z"
One or more actors, comma-separated — member emails or "api".
"user@example.com"
One or more actions, comma-separated, e.g. 'NAME_CHANGED', 'IMAGE_CHANGED', 'ASSIGNEE_CHANGED', 'LABEL_CHANGED', 'CUSTOM_PROPERTY_CHANGED', 'CHAT_ARCHIVED', 'CHAT_UNARCHIVED'
"STATUS_CHANGED,ASSIGNEE_CHANGED"
Sort by timestamp: 'asc' or 'desc' (default).
asc, desc "desc"
Response
Paginated list of audit log entries, newest first
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 logs array, not the total across all pages.
20
The logs in this page.
Show child attributes
Show child attributes
Was this page helpful?