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.calls.listCalls();
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/calls' \
-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,
"calls": [
{
"call_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"notification_id": "false_919999999999@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_919999999999@c.us",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "919999999999@c.us",
"chat_name": "John Doe",
"caller": "919999999999@c.us",
"direction": "incoming",
"result": "connected",
"handled_via": "periskope",
"timestamp": "2026-01-15T09:30:00.000Z",
"duration_seconds": 184,
"answered_by": "agent@example.com",
"transcript": {
"status": "done"
},
"summary": {
"text": "The customer asked about a delayed order. The agent confirmed it ships tomorrow and shared the tracking link."
},
"recording": {
"url": "https://api.periskope.app/app/media/periskope-call-attachments/00000000-0000-0000-0000-000000000000/phone-aaaaaaaaaaaaaaaa/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.wav?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"url_expires_at": "2026-01-15T10:30:00.000Z",
"duration_seconds": 184
}
}
]
}{
"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
}Call APIs
List Calls
Returns the organization’s call history, newest first, with recording links and AI summaries for calls handled in Periskope. Use Get a call for the transcript.
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.calls.listCalls();
console.log(response);
}
main();curl -X GET 'https://api.periskope.app/v1/calls' \
-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,
"calls": [
{
"call_id": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
"notification_id": "false_919999999999@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA_919999999999@c.us",
"org_id": "00000000-0000-0000-0000-000000000000",
"org_phone": "911111111111@c.us",
"chat_id": "919999999999@c.us",
"chat_name": "John Doe",
"caller": "919999999999@c.us",
"direction": "incoming",
"result": "connected",
"handled_via": "periskope",
"timestamp": "2026-01-15T09:30:00.000Z",
"duration_seconds": 184,
"answered_by": "agent@example.com",
"transcript": {
"status": "done"
},
"summary": {
"text": "The customer asked about a delayed order. The agent confirmed it ships tomorrow and shared the tracking link."
},
"recording": {
"url": "https://api.periskope.app/app/media/periskope-call-attachments/00000000-0000-0000-0000-000000000000/phone-aaaaaaaaaaaaaaaa/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA.wav?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"url_expires_at": "2026-01-15T10:30:00.000Z",
"duration_seconds": 184
}
}
]
}{
"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 calls, newest first unless sort_order=asc
Was this page helpful?