Get All Contacts
Supported & TestedReturn all contacts available for the connected Waplix instance using the public Contacts endpoint.
GEThttps://api.waplix.io/api/v1/contacts/index?instance_id=12345
Authentication
Authorization: Bearer YOUR_API_KEY Parameters Specification
| Parameter | Type | Required | Description |
|---|---|---|---|
| instance_id | string | Required | Required Waplix instance id |
| limit | number | Optional | Optional integer limit |
| search | string | Optional | Optional search string |
instance_id
stringReq Required Waplix instance id
limit
numberOpt Optional integer limit
search
stringOpt Optional search string
Usage Notes
Verified on production instance 29854.
Request Payload Example
Request
curl -X GET "https://api.waplix.io/api/v1/api/v1/contacts/index?instance_id=12345" \
-H "Authorization: Bearer YOUR_API_KEY"Success Response
Response · 200 OK
{
"success": true,
"data": {
"source": "local_logs",
"items": [
{
"id": "15551234567@s.whatsapp.net",
"lid": "15551234567@lid",
"name": "John Doe",
"notify": "John Doe",
"phone_number": "15551234567",
"is_business": false,
"is_blocked": false,
"input_contact_id": "15551234567@lid",
"phone_jid": "15551234567@s.whatsapp.net",
"lid_jid": "15551234567@lid",
"resolved_jid": "15551234567@lid",
"display_id": "15551234567@s.whatsapp.net",
"resolution_source": "stored_chat_id"
},
{
"id": "15551234568@s.whatsapp.net",
"lid": "15551234568@lid",
"name": "Demo User",
"notify": "Demo User",
"phone_number": "15551234568",
"is_business": false,
"is_blocked": false,
"input_contact_id": "15551234568@lid",
"phone_jid": "15551234568@s.whatsapp.net",
"lid_jid": "15551234568@lid",
"resolved_jid": "15551234568@lid",
"display_id": "15551234568@s.whatsapp.net",
"resolution_source": "stored_chat_id"
},
{
"id": "15551234569@s.whatsapp.net",
"lid": "15551234569@lid",
"name": "Jane Doe",
"notify": "Jane Doe",
"phone_number": "15551234569",
"is_business": false,
"is_blocked": false,
"input_contact_id": "15551234569@lid",
"phone_jid": "15551234569@s.whatsapp.net",
"lid_jid": "15551234569@lid",
"resolved_jid": "15551234569@lid",
"display_id": "15551234569@s.whatsapp.net",
"resolution_source": "stored_chat_id"
}
]
}
} Was this page helpful?