List WhatsApp Contacts

Retrieve all contacts who have sent or received WhatsApp messages.

GET /whatsapp/get-whatsapp-users/

Headers

Name	Value
Authorization	Bearer Access Token

Query Parameters

Name	Type	Required	Description
phone_number_id	string	Yes	Phone number ID to retrieve contacts for
search	string	Yes	Search term to filter contacts by name or number

Response

{
 "message": "Successfully retrieved all users",
 "success": true,
 "data": {
  "next": "<URL to next page>",
  "previous": "<URL to previous page>",
  "count": 100,
  "results": [
   {
    "id": 1,
    "name": "John Doe",
    "number": "<E.164 formatted number>",
    "country_code": "<country code>",
    "latest_message": {
     "message": "Hello",
     "status": "<status (SENT/RECEIVED)>",
     "datetime": "<formatted datetime E.g, 15-01-2025 10:30:00 AM>"
    },
    "unread_messages_count": "<number of unread messages>"
   }
  ]
 }
}