GET
/api/contactsRetrieves a list of all contacts synced with the WhatsApp session.
Get All Contacts
Retrieves a list of all contacts synced with the WhatsApp session.
Query Parameters
- paginated (boolean, optional) — When
true, returnsdata.itemsanddata.pagination. Default:false. - page (integer, optional) — Page number (only used when
paginated=true). Default:1. - limit (integer, optional) — Items per page (only used when
paginated=true). Default:20.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| paginated | boolean | No | When true, returns a paginated response with data.items and data.pagination. When false, returns a simple array of contacts in data. |
| page | integer | No | Page number (only used when paginated=true). |
| limit | integer | No | Items per page (only used when paginated=true). |
Code Examples
curl "https://www.wasenderapi.com/api/contacts?paginated=true&page=1&limit=20" \
-H "Authorization: Bearer YOUR_API_KEY"Response Examples
{
"success": true,
"data": [
{
"jid": "1234567890",
"name": "Contact Name",
"notify": "Contact Display Name",
"verifiedName": "Verified Business Name",
"imgUrl": "https:\/\/profile.pic.url\/image.jpg",
"status": "Hey there! I am using WhatsApp."
}
]
}