Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function listTasks() {
  const response = await client.task.getAll({
    limit: 50,
    offset: 0
  });

  console.log(response);
}

listTasks();
{
  "from": 1,
  "to": 1,
  "count": 1,
  "tasks": [
    {
      "task_id": "task-elnizmojzrjsogdm",
      "title": "Resolve customer escalation",
      "type": "message",
      "status": "closed",
      "priority": 3,
      "assignee": "ankit.singh@hashlabs.dev",
      "created_by": "anjali.pandey@hashlabs.dev",
      "last_updated_by": "ankit.singh@hashlabs.dev",
      "created_at": "2026-06-03T06:00:56.592+00:00",
      "last_updated_at": "2026-06-04T18:09:36.420636+00:00",
      "due_date": "2026-06-15T18:00:00+00:00",
      "remind_at": "2026-06-18T18:00:00+00:00",
      "notes": "Customer escalated via email — coordinate with support",
      "chat_id": "919205202401@c.us",
      "association": {
        "type": "message",
        "message_id": "true_4ca42ab6-77a9-428d-b614-5eb37bcf8f95_anjali.pandey@hashlabs.dev",
        "chat_id": "919205202401@c.us"
      },
      "completed_metadata": {
        "completed_at": "2026-06-04T18:09:36.407Z",
        "completed_by": "ankit.singh@hashlabs.dev"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
number
  • The offset value for paginating the results
  • Default 0
Example:

"0"

limit
number
  • The maximum number of tasks to retrieve
  • Default 1000
Example:

"50"

Response

200 - application/json

200 OK

from
number

The starting index of the returned tasks.

to
number

The ending index of the returned tasks.

count
number

The total count of tasks.

tasks
array

An array of task objects. Refer to the task object here