Skip to main content
GET
/
contacts
List all contacts
curl --request GET \
  --url https://wsapi.chat/contacts \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
[
  {
    "id": "1234567890@s.whatsapp.net",
    "lid": "222424242@lid",
    "phone": "1234567890",
    "device": 2,
    "fullName": "<string>",
    "firstName": "<string>",
    "pushName": "<string>",
    "businessName": "<string>",
    "inPhoneAddressBook": true
  }
]

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Response

List of contacts

​
id
string

Primary identifier (phone-based JID preferred, LID fallback)

Example:

"1234567890@s.whatsapp.net"

​
lid
string

LID-based JID (omitted if unknown)

Example:

"222424242@lid"

​
phone
string

Phone number without prefix (omitted if unknown)

Example:

"1234567890"

​
device
integer

Device number (omitted if 0)

Example:

2

​
fullName
string
​
firstName
string
​
pushName
string
​
businessName
string
​
inPhoneAddressBook
boolean