List All Chats

import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210' }); async function getChats() { const response = await client.chat.getChats({ chat_type: 'group', }); console.log(response); } getChats();

{ "chats": [ { "assigned_to": null, "chat_access": null, "chat_id": "120363393294700553@g.us", "chat_image": null, "chat_name": "Test New 1039", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "2025-01-24T05:11:03+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/CGpMRj9oKDVGHSho7wOkIA", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 1, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-24T05:11:10.691753+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363373936603867@g.us", "chat_image": null, "chat_name": "Testing1234", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "2025-01-20T12:03:21+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": null, "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": { "ack": "4", "author": null, "body": "Hello, East Jenniferfurt!", "broadcast": null, "broadcast_id": null, "chat_id": "120363373936603867@g.us", "delivery_info": { "delivered": { "919971844008@c.us": 1737457813000 }, "delivered_count": 1, "pending": [], "read": { "919971844008@c.us": 1737457847000 }, "read_count": 1 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": true, "fts": "'east':2 'hello':1 'jenniferfurt':3", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": true, "id": "3EB0E9AF26D15A11C93960E7CACC60B03A614A07", "remote": "120363373936603867@g.us", "serialized": "true_120363373936603867@g.us_3EB0E9AF26D15A11C93960E7CACC60B03A614A07" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "true_120363373936603867@g.us_3EB0E9AF26D15A11C93960E7CACC60B03A614A07", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "918527184400@c.us", "sent_message_id": "90012031-9e18-4cf6-b169-f5dd50b26dcf", "timestamp": "2025-01-21T11:10:13+00:00", "to": null, "token": null, "unique_id": "3EB0E9AF26D15A11C93960E7CACC60B03A614A07", "updated_at": "2025-01-21T11:14:16.233+00:00", "vcards": null }, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:04.316415+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363376050029178@g.us", "chat_image": null, "chat_name": "Test Czech Republic", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "2025-01-20T11:40:20+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/B7NJcQ8qKR68G4CMHvSx9n", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 1, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:05.428429+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363374949245199@g.us", "chat_image": null, "chat_name": "Test Burundi", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "2025-01-20T11:38:42+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/BoU9NjAj7kjAeZT1CktwnM", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 1, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:16.574283+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363371308389685@g.us", "chat_image": null, "chat_name": "Test Ukraine", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "2025-01-11T11:47:50+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/IxVB9Eup9aREKqmyOC6JyK", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-24T03:21:54.192067+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363372525172897@g.us", "chat_image": null, "chat_name": "Test Jordan", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/CHfYB8MxN4d2wI2mjFI2wd", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": { "ack": "0", "author": null, "body": "morning broadcast", "broadcast": false, "broadcast_id": null, "chat_id": "120363372525172897@g.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'broadcast':2 'morn':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3EB0B00DE7E55A4C17E9736D460E32F1D9EF22A9", "remote": "120363372525172897@g.us", "serialized": "false_120363372525172897@g.us_3EB0B00DE7E55A4C17E9736D460E32F1D9EF22A9" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_120363372525172897@g.us_3EB0B00DE7E55A4C17E9736D460E32F1D9EF22A9", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919971844008@c.us", "sent_message_id": null, "timestamp": "2025-01-21T04:12:02+00:00", "to": null, "token": null, "unique_id": "3EB0B00DE7E55A4C17E9736D460E32F1D9EF22A9", "updated_at": "2025-01-21T07:47:56.917+00:00", "vcards": null }, "member_add_mode": "false", "member_count": 3, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:15.256053+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363386347133520@g.us", "chat_image": null, "chat_name": "Test Guyana", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/BPF2DuHV8lkH6GnDr1VqlT", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:13.375748+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363388696354849@g.us", "chat_image": null, "chat_name": "Test Tanzania", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/IEo71cjf8gyGiqBQc9Qnaz", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:13.313762+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363392706769636@g.us", "chat_image": null, "chat_name": "Test Micronesia", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/Bz8weeyUHOWG56ur7fXbNE", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:12.356512+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363387379991154@g.us", "chat_image": null, "chat_name": "Test British Indian Ocean Territory (Chagos Archipelago)", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/BigGuHS9sb23hlHMRtweVp", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:10.380164+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363389171465741@g.us", "chat_image": null, "chat_name": "Test Sri Lanka", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/LHOW1jCsZYM0SqGK5o65NL", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 3, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:10.304499+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363329861739657@g.us", "chat_image": null, "chat_name": "Test Skope Final 947", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/K2oBToo4ZSNCUbt8Z1dfr1", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": { "ack": "0", "author": null, "body": "123", "broadcast": null, "broadcast_id": null, "chat_id": "120363329861739657@g.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'123':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3EB02B5D79E809F09D18C38DC398BCD099E09D5C", "remote": "120363329861739657@g.us", "serialized": "false_120363329861739657@g.us_3EB02B5D79E809F09D18C38DC398BCD099E09D5C" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_120363329861739657@g.us_3EB02B5D79E809F09D18C38DC398BCD099E09D5C", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919971844008@c.us", "sent_message_id": null, "timestamp": "2024-12-18T10:14:03+00:00", "to": null, "token": null, "unique_id": "3EB02B5D79E809F09D18C38DC398BCD099E09D5C", "updated_at": "2025-01-21T07:47:57.308+00:00", "vcards": null }, "member_add_mode": "false", "member_count": 3, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:09.319248+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363371655584481@g.us", "chat_image": null, "chat_name": "Test Finland", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/BonKrc8QQfe8RjFI6qNJTh", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:07.220729+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363388281538713@g.us", "chat_image": null, "chat_name": "Test Chile", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/GKvB8VbgX59ClibbEKFxY3", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": { "ack": "0", "author": null, "body": "morning broadcast", "broadcast": false, "broadcast_id": null, "chat_id": "120363388281538713@g.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'broadcast':2 'morn':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3EB0903DD9BE0FECFD0FC6293877F55B1D71CB6C", "remote": "120363388281538713@g.us", "serialized": "false_120363388281538713@g.us_3EB0903DD9BE0FECFD0FC6293877F55B1D71CB6C" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_120363388281538713@g.us_3EB0903DD9BE0FECFD0FC6293877F55B1D71CB6C", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919971844008@c.us", "sent_message_id": null, "timestamp": "2025-01-21T04:12:02+00:00", "to": null, "token": null, "unique_id": "3EB0903DD9BE0FECFD0FC6293877F55B1D71CB6C", "updated_at": "2025-01-21T07:47:56.946+00:00", "vcards": null }, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:06.295071+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363387670530253@g.us", "chat_image": null, "chat_name": "Test Mali", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/DlYalEdkxfsBFt4OPAUUUM", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:03.266682+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363391093262494@g.us", "chat_image": null, "chat_name": "Test Liberia", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/JfZOBaDWwlBBMFsJ2Yb81z", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:03.10113+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363373397909338@g.us", "chat_image": null, "chat_name": "Test Central African Republic", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/GBJjd4FATw46cTJrnuELF4", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 1, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:01.158254+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363372297359294@g.us", "chat_image": null, "chat_name": "Test Sao Tome and Principe", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/LEEf0ucs43ICdvaMrEIwHZ", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 1, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:01.134314+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363373761356282@g.us", "chat_image": null, "chat_name": "Test Nauru", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/FGrF4wyevSZCb2Aw9sj8j0", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:00.097896+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363331984403446@g.us", "chat_image": null, "chat_name": "Test Skope Final 5", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/GwTNgUrKe7N9HPkHiCEoIs", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": { "ack": "0", "author": null, "body": "Hey", "broadcast": null, "broadcast_id": null, "chat_id": "120363331984403446@g.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'hey':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "75EF52B48E7850F1CF98BBAFE304EC51", "remote": "120363331984403446@g.us", "serialized": "false_120363331984403446@g.us_75EF52B48E7850F1CF98BBAFE304EC51" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_120363331984403446@g.us_75EF52B48E7850F1CF98BBAFE304EC51", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919971844008@c.us", "sent_message_id": null, "timestamp": "2024-10-24T03:59:11+00:00", "to": null, "token": null, "unique_id": "75EF52B48E7850F1CF98BBAFE304EC51", "updated_at": "2025-01-21T07:47:57.372+00:00", "vcards": null }, "member_add_mode": "true", "member_count": 3, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:19.483616+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363378277037444@g.us", "chat_image": null, "chat_name": "Test <> Xindus 2", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": null, "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/Jc8jJTRDm6w6nkXTZA5CsE", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:17.570189+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363352652386702@g.us", "chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F120363352652386702%40g.us.jpg?timestamp=1737445696596", "chat_name": "Test Skope Final 9473", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": "Wazza dobbs", "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/IZB4Zq3Ylt556F2wfWNrm8", "is_exited": false, "is_muted": true, "label_ids": {}, "latest_message": { "ack": "0", "author": null, "body": "Heyy", "broadcast": null, "broadcast_id": null, "chat_id": "120363352652386702@g.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'heyi':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "147C1AF10C9C934CF18A0B69FF949968", "remote": "120363352652386702@g.us", "serialized": "false_120363352652386702@g.us_147C1AF10C9C934CF18A0B69FF949968" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_120363352652386702@g.us_147C1AF10C9C934CF18A0B69FF949968", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919971844008@c.us", "sent_message_id": null, "timestamp": "2025-01-01T15:30:20+00:00", "to": null, "token": null, "unique_id": "147C1AF10C9C934CF18A0B69FF949968", "updated_at": "2025-01-21T07:47:57.308+00:00", "vcards": null }, "member_add_mode": "false", "member_count": 3, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:16.599646+00:00" }, { "assigned_to": null, "chat_access": null, "chat_id": "120363378751945209@g.us", "chat_image": "https://storage.googleapis.com/periskope-images/2997dd64-89bf-48d3-9a22-b314fca017e5%2F120363378751945209%40g.us.jpg?timestamp=1737445695527", "chat_name": "Test Skope New", "chat_org_phones": [ "918527184400@c.us" ], "chat_type": "group", "closed_at": null, "created_at": "1970-01-01T00:00:00+00:00", "custom_properties": {}, "flag_count_map": null, "group_description": "Wazza dobbs", "hubspot_metadata": {}, "info_admins_only": false, "invite_link": "https://chat.whatsapp.com/invite/Bc5DsgO7y3nDrwChbE1Poe", "is_exited": false, "is_muted": false, "label_ids": {}, "latest_message": null, "member_add_mode": "false", "member_count": 2, "message_unread_count": null, "messages_admins_only": false, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "updated_at": "2025-01-21T07:48:15.531487+00:00" } ], "count": 23, "from": 1, "to": 23 }

Authorizations

Authorization

string

header

required

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

Headers

x-phone

string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Example:

"{{orgPhone}}"

Query Parameters

offset

number

The offset value for paginating the results
Default 0

Example:

"0"

limit

number

The maximum number of chats to retrieve
Default 2000

Example:

"1000"

chat_type

string

Filter chat by type of user, group or business

Example:

"group"

label

string

Filter all chats that contain a specific label provide
You can provide the name of the label or label_id

Example:

"label-kbvlbnvesomvgqpt"

start_time

string

The start_time to filter the results

Example:

"2025-04-25 or 2025-04-25T00:00:00Z"

end_time

string

The end_time to filter the results

Example:

"2025-04-31 or 2025-04-31T23:59:59Z"

Response

200 OK

Note: members associated with a chat are not returned. You can fetch a specific chat by calling the Get Chat By ID endpoint

from

number

The starting index of the returned chats.

Example:

1

number

The ending index of the returned chats.

Example:

10

count

number

The total count of chats.

Example:

10

chats

any[]

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

API

Chat APIs

Group Settings APIs

Message APIs

Contact APIs

Ticket APIs

Queue APIs

Phone APIs

Notes APIs

Reaction APIs

Webhooks

Authorizations

Headers

Query Parameters

Response