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 getContacts() {
  const response = await client.contact.getAll();

  console.log(response);
}

getContacts();
{
  "contacts": [
    {
      "contact_color": "#7D9EF1",
      "contact_id": "919289665999@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919289665999%40c.us.jpg?timestamp=1737373011790",
      "contact_name": "Periskope Sales",
      "contact_type": "business",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": true,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-20T11:36:51.793829+00:00"
    },
    {
      "contact_color": "#DC2626",
      "contact_id": "919537851844@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us.jpg?timestamp=1737141387093",
      "contact_name": "Bk",
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {
        "label-ukjqhqngnakncalm": true,
        "label-wwfrdqogccexahnv": true
      },
      "labels": [
        "label1",
        "label2"
      ],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-20T08:52:04.760153+00:00"
    },
    {
      "contact_color": "#007BFC",
      "contact_id": "6282123235653@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F6282123235653%40c.us.jpg?timestamp=1737358933768",
      "contact_name": "Periskope Indonesia",
      "contact_type": "business",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-20T07:42:13.777762+00:00"
    },
    {
      "contact_color": "#C4532D",
      "contact_id": "447403688342@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F447403688342%40c.us.jpg?timestamp=1737357784557",
      "contact_name": "Periskope Business",
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": true,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-20T07:23:04.572048+00:00"
    },
    {
      "contact_color": "#C4532D",
      "contact_id": "918527184400@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918527184400%40c.us.jpg?timestamp=1737277451340",
      "contact_name": "Support",
      "contact_type": "user",
      "is_imported": null,
      "is_internal": true,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-19T09:04:11.356664+00:00"
    },
    {
      "contact_color": "#5E47DE",
      "contact_id": "919319622936@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919319622936%40c.us.jpg?timestamp=1737141392918",
      "contact_name": null,
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-17T19:16:32.921911+00:00"
    },
    {
      "contact_color": "#25D366",
      "contact_id": "919877534373@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919877534373%40c.us.jpg?timestamp=1737141392917",
      "contact_name": null,
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-17T19:16:32.92187+00:00"
    },
    {
      "contact_color": "#7F66FF",
      "contact_id": "918297136234@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918297136234%40c.us.jpg?timestamp=1737141392020",
      "contact_name": null,
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-17T19:16:32.023889+00:00"
    },
    {
      "contact_color": "#02A698",
      "contact_id": "919035577330@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919035577330%40c.us.jpg?timestamp=1737141391951",
      "contact_name": "Yasin 3",
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": true,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-17T19:16:31.956806+00:00"
    },
    {
      "contact_color": "#9333EA",
      "contact_id": "918904950033@c.us",
      "contact_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F918904950033%40c.us.jpg?timestamp=1737141390937",
      "contact_name": null,
      "contact_type": "user",
      "is_imported": null,
      "is_internal": null,
      "is_my_contact": null,
      "is_wa_contact": false,
      "label_ids": {},
      "labels": [],
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "updated_at": "2025-01-17T19:16:30.940934+00:00"
    }
  ],
  "count": 10,
  "from": 1,
  "to": 10
}

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 contacts to retrieve
  • Default 2000
Example:

"10"

Response

200 OK

Note: chat_ids associated with a contact are not returned. You can fetch a specific contact by contact_id to get all chat_ids associated with it

​
from
number

The starting index of the returned contacts

​
to
number

The ending index of the returned contacts

​
count
number

The total count of contacts.

​
contacts
any[]

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