Get Stored Contacts (CRM Database)
Retrieve paginated, searchable contacts stored in your Wawp cloud database without querying the live WhatsApp device.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Use this endpoint to power CRM contact tables and search bars.
Pass page and limit parameters for smooth pagination.
Cloud-Stored Contacts Directory
The /v2/contacts/stored endpoint queries your indexed Wawp database (wawp_contacts) directly. Unlike /v2/contacts/all, it has zero impact on your WhatsApp session rate limits and supports instant pagination and keyword search across phone numbers, names, pushnames, and LIDs.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Query Parameters & Request Body
Supported in URL Query String or JSON Bodystring | Your unique WhatsApp Instance ID. Example: | ||
string | Your API Access Token. Example: | ||
string | — | Optional session name (alternative to instance_id). Example: | |
number | — | Optional workspace ID filter. Example: | |
number | — | Page number for pagination (starts at 1). Default: 1Example: | |
number | — | Number of contacts per page (1–100). Default: 50Example: | |
string | — | Search term matching phone, name, pushname, or LID. Example: |
Build with AI using Wawp MCP
MCP READYConnect Wawp API directly to Cursor, Windsurf, or Claude Desktop. Let AI write, test, and execute your WhatsApp integration code automatically!
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"status": "success",
"total": 1,
"page": 1,
"limit": 50,
"totalPages": 1,
"data": {
"0": {
"id": 101,
"phone": "201012345678",
"lid": "123456789@lid",
"name": "Ahmed Ali",
"pushname": "Ahmed",
"on_whatsapp": 1,
"status": "active"
}
}
}Command Palette
Search for a command to run...