Contacts & Chats (API)

Last updated: February 19, 2026

Contacts & Chats (API)

List Contacts

GET /api/v1/contacts

Query Parameters

ParameterTypeDescription
pagenumberPage number (default: 1)
limitnumberItems per page (default: 50)
searchstringSearch by name or number

Response

{
  "contacts": [
    {
      "id": 1,
      "name": "Ahmad",
      "phone": "60123456789",
      "email": "[email protected]",
      "tags": ["vip", "customer"],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 50
}

List Chats

GET /api/v1/chats

Query Parameters

ParameterTypeDescription
pagenumberPage number
limitnumberItems per page
instanceIdnumberFilter by instance

Response

{
  "chats": [
    {
      "id": 1,
      "contactName": "Ahmad",
      "phone": "60123456789",
      "lastMessage": "Thank you!",
      "lastMessageAt": "2024-01-15T10:30:00Z",
      "unreadCount": 2
    }
  ],
  "total": 80,
  "page": 1,
  "limit": 50
}

List Instances

GET /api/v1/instances

Returns all WhatsApp instances with their connection status.

Check Session Window (WABA)

GET /api/v1/session-window?phone=60123456789&instanceId=1

Check if the 24-hour conversation window is still active for a specific contact. If active, you can send regular messages. If not, you need to use a template.