WhatsApp Contacts

Access and query the WhatsApp contacts associated with your connected session.

List Contacts

GET /v1/whatsapp/contacts

Returns the synced contact list for a session, including profile pictures where available.

Query Parameters

Parameter	Type	Required	Description
session_id	string	Yes	The session whose contacts to retrieve.
page	integer	No	Page number (default: 1).
per_page	integer	No	Results per page (default: 25, max: 100).

cURL

curl "https://sendapi.co/v1/whatsapp/contacts?session_id=sess_01H8BKF...Z2T" \
  -H "Authorization: Bearer sk_live_123456789"

Node.js

const contacts = await client.whatsapp.contacts.list({
  session_id: 'sess_01H8BKF...Z2T'
});

Python

contacts = client.whatsapp.contacts.list(session_id="sess_01H8BKF...Z2T")

Response

{
  "data": [
    {
      "phone": "+447700900000",
      "name": "Alice Smith",
      "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/...",
      "is_whatsapp_user": true
    }
  ],
  "meta": { "total": 128, "page": 1, "per_page": 25 }
}

---

Check WhatsApp Registration

GET /v1/whatsapp/contacts/{phone}/check

Check whether a phone number is registered on WhatsApp. Useful for validating recipients before sending messages.

Path Parameters

Parameter	Type	Required	Description
phone	string	Yes	Phone number in E.164 format (e.g., +447700900000).

Query Parameters

Parameter	Type	Required	Description
session_id	string	Yes	The session to use for the lookup.

cURL

curl "https://sendapi.co/v1/whatsapp/contacts/+447700900000/check?session_id=sess_01H8BKF...Z2T" \
  -H "Authorization: Bearer sk_live_123456789"

Node.js

const result = await client.whatsapp.contacts.check('+447700900000', {
  session_id: 'sess_01H8BKF...Z2T'
});

if (result.is_whatsapp_user) {
  console.log('Safe to send a WhatsApp message');
}

Response

{
  "phone": "+447700900000",
  "is_whatsapp_user": true,
  "whatsapp_id": "447700900000@s.whatsapp.net"
}

Validate Before Bulk Sending

Use this endpoint to pre-validate your recipient list before running a bulk send. Messages sent to non-WhatsApp numbers will fail and may count toward your session's error rate.