ChakraHQ APIs
HomeSign In
HomeSign In
  1. Whatsapp
  • API Keys
  • Response Format
  • Whatsapp
    • Inbound Events Webhook
    • How to figure out pluginId and whatsappPhoneNumberId
    • Pass Through APIs
      • WhatsApp Messages API (pass-through)
      • Send WhatsApp session message
      • Create WhatsApp Message Template (pass-through)
      • List WhatsApp Message Templates (pass-through)
      • Update WhatsApp Message Template (pass-through)
      • Fetch Whatsapp Media API
      • Show Whatsapp Media Attachments API
    • Send Whatsapp Template Message For Process
      POST
    • Send Whatsapp Template Message For A Phone Number
      POST
    • Upload Public Media
      POST
    • Show Whatsapp Media API
      GET
    • Create a lead
      POST
    • List previous messages for a phone number
      POST
    • List chats
      POST
    • List chat messages for a chat
      POST
  • Platform
    • Process
      • Fetch Process By Id
      • List Processes
      • Create Process
      • Update Process
      • Update Process By Primary Key
      • Delete Process
      • Delete Process By Primary Key Value
      • Bulk Create Process API
      • Bulk Update Process API
    • Task
      • Create Task API
    • User
      • List Users API
      • List Users API (V2)
      • Fetch User API
      • Fetch User API (V2)
      • Update User API
    • Photo
      • Fetch Photo API
      • Upload Photo API
      • Upload Photo API With Id
    • Background Job
      • Fetch Background Job
      • Fetch Background Job Entries API
    • Fetch Config
      GET
  1. Whatsapp

List chats

Developing
POST
https://api.chakrahq.com/v1/ext/chat
This API allows you to list chat sessions for your team

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Body Params application/jsonRequired

Examples
{
  "orderField": "createdAt",
  "limit": 10,
  "page": 1
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://api.chakrahq.com/v1/ext/chat' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "orderField": "createdAt",
  "limit": 10,
  "page": 1
}'

Responses

🟢200Success
application/json
Body

Example
{
  "_data": [
    {
      "id": "4abc74ba-dfd8-423e-8ef5-fdf3ebbbd487",
      "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
      "provider": "WHATSAPP",
      "providerHandle": "916363180853",
      "providerHandleId": "105966265503413",
      "externalId": "",
      "initiatedDirection": "INBOUND",
      "primaryContact": {
        "id": "102b44f2-272b-4405-8af8-b0dc73002a5d",
        "name": "Test Sahoo",
        "firstName": "Test Sahoo",
        "lastName": "",
        "photo": "/5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee/contact/816eb004-256f-44ed-b580-79dd106be1da.png",
        "createdAt": 1715251767568,
        "updatedAt": 1737360026404
      },
      "primaryContactHandle": {
        "id": "98450ad3-e6a5-424b-b089-eeadff539c45",
        "label": "Whatsapp",
        "type": "WHATSAPP",
        "value": "+919901258433",
        "contact": "102b44f2-272b-4405-8af8-b0dc73002a5d",
        "createdAt": 1715251767593,
        "updatedAt": 1715251767593
      },
      "assignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
      "latestMessage": {
        "id": "47eeb60e-ab3e-466a-880d-655270222f4e",
        "chat": "4abc74ba-dfd8-423e-8ef5-fdf3ebbbd487",
        "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
        "externalId": "wamid.HBgMOTE5OTAxMjU4NDMzFQIAERgSM0JCQUEyMTA0MDc3RjE1N0MwAA==",
        "provider": "WHATSAPP",
        "dataType": "text",
        "body": {
          "text": {
            "body": "How can i help you"
          }
        },
        "text": "How can i help you",
        "attachments": null,
        "deliveryStatus": "DELIVERED",
        "direction": "OUTBOUND",
        "procedure": null,
        "process": "7417c17d-ace1-4977-867d-eef2ba320263",
        "campaign": null,
        "inReplyTo": null,
        "timestamp": 1762277358132,
        "source": null,
        "createdAt": 1762277358175,
        "updatedAt": 1762277358175
      },
      "latestMessageTs": 1762277358132,
      "latestMessageDirection": "OUTBOUND",
      "status": "OPEN",
      "startedAt": 1756971550514,
      "closedAt": 0,
      "process": "7417c17d-ace1-4977-867d-eef2ba320263",
      "procedure": null,
      "chatInbox": "b84c159b-8953-4f46-93f8-8d0f565fb810",
      "assignedChatbot": null,
      "chatbotData": {
        "ba7f9b55-3163-4112-9415-96080b9dfee9": {
          "city": "Manali"
        },
        "d000d40e-67c9-4d69-98fc-bf64bb688539": {
          "query": "Anubhav Sahoo and 1 others"
        }
      },
      "pageUrl": "",
      "visitor": null,
      "data": {},
      "createdAt": 1756971550536,
      "updatedAt": 1762322738337
    },
    {
      "id": "1965c0e9-9e81-4c35-a79c-b6fe90757fd2",
      "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
      "provider": "WHATSAPP",
      "providerHandle": "916363180853",
      "providerHandleId": "105966265503413",
      "externalId": "",
      "initiatedDirection": "INBOUND",
      "primaryContact": {
        "id": "102b44f2-272b-4405-8af8-b0dc73002a5d",
        "name": "Test Sahoo",
        "firstName": "Test Sahoo",
        "lastName": "",
        "photo": "/5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee/contact/816eb004-256f-44ed-b580-79dd106be1da.png",
        "createdAt": 1715251767568,
        "updatedAt": 1737360026404
      },
      "primaryContactHandle": {
        "id": "98450ad3-e6a5-424b-b089-eeadff539c45",
        "label": "Whatsapp",
        "type": "WHATSAPP",
        "value": "+919901258433",
        "contact": "102b44f2-272b-4405-8af8-b0dc73002a5d",
        "createdAt": 1715251767593,
        "updatedAt": 1715251767593
      },
      "assignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
      "latestMessage": {
        "id": "d3d10f77-9449-4d7b-8ff0-320512b52a02",
        "chat": "1965c0e9-9e81-4c35-a79c-b6fe90757fd2",
        "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
        "externalId": "TEST.dc555359-aacf-4c9e-87ab-12da8b526f94",
        "provider": "WHATSAPP",
        "dataType": "text",
        "body": {
          "body": "what is my lead id?"
        },
        "text": "what is my lead id?",
        "attachments": null,
        "deliveryStatus": "DELIVERED",
        "direction": "INBOUND",
        "procedure": null,
        "process": "7417c17d-ace1-4977-867d-eef2ba320263",
        "campaign": null,
        "inReplyTo": null,
        "timestamp": 1761908547000,
        "source": null,
        "createdAt": 1761908547395,
        "updatedAt": 1761908547395
      },
      "latestMessageTs": 1761908547000,
      "latestMessageDirection": "INBOUND",
      "status": "CLOSED",
      "startedAt": 1757063174884,
      "closedAt": 0,
      "process": "7417c17d-ace1-4977-867d-eef2ba320263",
      "procedure": null,
      "chatInbox": "55a69431-f1a9-4a15-a600-9fbe39de1a8a",
      "assignedChatbot": null,
      "chatbotData": {
        "d000d40e-67c9-4d69-98fc-bf64bb688539": {
          "query": "What types of products do you sell?"
        }
      },
      "pageUrl": "",
      "visitor": null,
      "data": {},
      "createdAt": 1757063174954,
      "updatedAt": 1761908566903
    },
    {
      "id": "80ea0b3a-36dc-4b6b-8014-693a197d4c5d",
      "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
      "provider": "WHATSAPP",
      "providerHandle": "916363180853",
      "providerHandleId": "105966265503413",
      "externalId": "",
      "initiatedDirection": "INBOUND",
      "primaryContact": {
        "id": "c3e9a587-aeba-498c-8556-0fa531636ac8",
        "name": "John",
        "firstName": "John",
        "lastName": "",
        "photo": "",
        "createdAt": 1736927055621,
        "updatedAt": 1736928777153
      },
      "primaryContactHandle": {
        "id": "a203f9c5-68e4-453e-83ce-97e0bfe43c20",
        "label": "Whatsapp",
        "type": "WHATSAPP",
        "value": "+912200220023",
        "contact": "c3e9a587-aeba-498c-8556-0fa531636ac8",
        "createdAt": 1736927055668,
        "updatedAt": 1736927055668
      },
      "assignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
      "latestMessage": {
        "id": "dde91df1-3f32-45a4-9889-3526136bc083",
        "chat": "80ea0b3a-36dc-4b6b-8014-693a197d4c5d",
        "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
        "externalId": "wamid.HBgMOTESTTAxMjU5NDMzFQIAEhgUM0VCMDM3RjlEQTNDQTBEMjQ3Q298",
        "provider": "WHATSAPP",
        "dataType": "text",
        "body": {
          "body": "sep262025_4"
        },
        "text": "sep262025_4",
        "attachments": null,
        "deliveryStatus": "DELIVERED",
        "direction": "INBOUND",
        "procedure": null,
        "process": "b1c3948a-7e11-45b4-9a03-7c745e6aa941",
        "campaign": null,
        "inReplyTo": null,
        "timestamp": 1758894145000,
        "source": null,
        "createdAt": 1758894155381,
        "updatedAt": 1758894156005
      },
      "latestMessageTs": 1758894145000,
      "latestMessageDirection": "INBOUND",
      "status": "OPEN",
      "startedAt": 1758894154943,
      "closedAt": 0,
      "process": "b1c3948a-7e11-45b4-9a03-7c745e6aa941",
      "procedure": null,
      "chatInbox": "55a69431-f1a9-4a15-a600-9fbe39de1a8a",
      "assignedChatbot": null,
      "chatbotData": null,
      "pageUrl": "",
      "visitor": null,
      "data": {},
      "createdAt": 1758894154957,
      "updatedAt": 1759476765758
    },
    {
      "id": "2a86d3d4-13b1-4122-8832-c2ac5aa0491d",
      "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
      "provider": "WHATSAPP",
      "providerHandle": "916363180853",
      "providerHandleId": "105966265503413",
      "externalId": "",
      "initiatedDirection": "INBOUND",
      "primaryContact": {
        "id": "c3e9a587-aeba-498c-8556-0fa531636ac8",
        "name": "John",
        "firstName": "John",
        "lastName": "",
        "photo": "",
        "createdAt": 1736927055621,
        "updatedAt": 1736928777153
      },
      "primaryContactHandle": {
        "id": "a203f9c5-68e4-453e-83ce-97e0bfe43c20",
        "label": "Whatsapp",
        "type": "WHATSAPP",
        "value": "+912200220023",
        "contact": "c3e9a587-aeba-498c-8556-0fa531636ac8",
        "createdAt": 1736927055668,
        "updatedAt": 1736927055668
      },
      "assignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
      "latestMessage": {
        "id": "fb9e8691-75b2-4954-b51b-0d8ed52802ee",
        "chat": "2a86d3d4-13b1-4122-8832-c2ac5aa0491d",
        "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
        "externalId": "wamid.HBgMOTESTTAxMjU5NDMzFQIAEhgUM0VCMDM3RjlEQTNDQTBEMjQ3Q299",
        "provider": "WHATSAPP",
        "dataType": "text",
        "body": {
          "body": "sep262025_4"
        },
        "text": "sep262025_4",
        "attachments": null,
        "deliveryStatus": "DELIVERED",
        "direction": "INBOUND",
        "procedure": null,
        "process": "b1c3948a-7e11-45b4-9a03-7c745e6aa941",
        "campaign": null,
        "inReplyTo": null,
        "timestamp": 1758894165000,
        "source": null,
        "createdAt": 1758894177409,
        "updatedAt": 1758894177745
      },
      "latestMessageTs": 1758894165000,
      "latestMessageDirection": "INBOUND",
      "status": "OPEN",
      "startedAt": 1758894176997,
      "closedAt": 0,
      "process": "b1c3948a-7e11-45b4-9a03-7c745e6aa941",
      "procedure": null,
      "chatInbox": "55a69431-f1a9-4a15-a600-9fbe39de1a8a",
      "assignedChatbot": null,
      "chatbotData": null,
      "pageUrl": "",
      "visitor": null,
      "data": {},
      "createdAt": 1758894177014,
      "updatedAt": 1758894180640
    },
    {
      "id": "6ceb64b8-fe83-40ab-9fca-1b9ee6e45812",
      "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
      "provider": "WHATSAPP",
      "providerHandle": "916363180853",
      "providerHandleId": "105966265503413",
      "externalId": "",
      "initiatedDirection": "INBOUND",
      "primaryContact": {
        "id": "c3e9a587-aeba-498c-8556-0fa531636ac8",
        "name": "John",
        "firstName": "John",
        "lastName": "",
        "photo": "",
        "createdAt": 1736927055621,
        "updatedAt": 1736928777153
      },
      "primaryContactHandle": {
        "id": "a203f9c5-68e4-453e-83ce-97e0bfe43c20",
        "label": "Whatsapp",
        "type": "WHATSAPP",
        "value": "+912200220023",
        "contact": "c3e9a587-aeba-498c-8556-0fa531636ac8",
        "createdAt": 1736927055668,
        "updatedAt": 1736927055668
      },
      "assignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
      "latestMessage": {
        "id": "b96db17f-8dff-40db-bff3-3233dae42377",
        "chat": "6ceb64b8-fe83-40ab-9fca-1b9ee6e45812",
        "plugin": "d83e1d23-50b8-4d87-8f92-842a0ac516f6",
        "externalId": "wamid.HBgMOTESTTAxMjU5NDMzFQIAEhgUM0VCMDM3RjlEQTNDQTBEMjQ3Q297",
        "provider": "WHATSAPP",
        "dataType": "text",
        "body": {
          "body": "sep262025_4"
        },
        "text": "sep262025_4",
        "attachments": null,
        "deliveryStatus": "DELIVERED",
        "direction": "INBOUND",
        "procedure": null,
        "process": "b1c3948a-7e11-45b4-9a03-7c745e6aa941",
        "campaign": null,
        "inReplyTo": null,
        "timestamp": 1758893544000,
        "source": null,
        "createdAt": 1758893560232,
        "updatedAt": 1758893560232
      },
      "latestMessageTs": 1758893544000,
      "latestMessageDirection": "INBOUND",
      "status": "CLOSED",
      "startedAt": 1758893527318,
      "closedAt": 0,
      "process": "b1c3948a-7e11-45b4-9a03-7c745e6aa941",
      "procedure": null,
      "chatInbox": "55a69431-f1a9-4a15-a600-9fbe39de1a8a",
      "assignedChatbot": null,
      "chatbotData": null,
      "pageUrl": "",
      "visitor": null,
      "data": {},
      "createdAt": 1758893527332,
      "updatedAt": 1758894135658
    }
  ]
}
Modified at 2025-11-05 17:22:06
Previous
List previous messages for a phone number
Next
List chat messages for a chat
Built with