Get All Contacts

Retrieves a list of all known contacts from the connected WhatsApp account's address book and chat history.

GET

https://api.wawp.net/v2/contacts/all?instance_id=123456789&access_token=123456789&limit=50&offset=0&sortBy=name&sortOrder=ASC

Authentication Required

Login to swap the placeholders with your real Instance ID and Access Token.

Log In

Test /v2/contacts/all endpoint

Supports

GET

No query parameters required

This endpoint doesn't expect data in the URL.

Sync

Returns all contacts sync'd from the phone's address book.

Performance

Can be slow for accounts with thousands of contacts. Use caching.

Best practices

Call this only on startup to bootstrap your local database.
Filter out contacts without WhatsApp accounts (isWAContact: false).

Request Parameters

Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.

URL Parameters

Passed in the URL query string

`string`		Your unique WhatsApp Instance ID Example:
`string`		Your API Access Token Example:
`string`	—	Maximum number of contacts to return (1-1000) Example:
`string`	—	Number of contacts to skip Example:
`string`	—	Field to sort by (e.g., name) Example:
`string`	—	Sort order (ASC or DESC) Example:

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.

1const baseUrl = "https://api.wawp.net";
2const endpoint = "/v2/contacts/all";
3const params = new URLSearchParams({
4  "instance_id": "123456789",
5  "access_token": "123456789",
6  "limit": "50",
7  "offset": "0",
8  "sortBy": "name",
9  "sortOrder": "ASC"
10}).toString();
11
12
13fetch(`${baseUrl}${endpoint}${params ? '?' + params : ''}`, {
14  method: "GET",
15  headers: { "Content-Type": "application/json" },
16  
17})
18  .then(async (response) => {
19    if (response.ok) {
20      const data = await response.json();
21      console.log("Success:", data);
22      return data;
23    }
24    
25    // Error Handling
26    if (response.status === 401) {
27      console.error("Error 401: Unauthorized - Invalid or Missing Access Token");
28    }
29    if (response.status === 400) {
30      console.error("Error 400: Bad Request - Invalid Parameter Format");
31    }
32    if (response.status === 500) {
33      console.error("Error 500: Internal Server Error - Unexpected Failure");
34    }
35
36    const errorText = await response.text();
37    console.error(`Error ${response.status}: ${errorText}`);
38  })
39  .catch((error) => console.error("Network Error:", error));

Interactive SamplesUTF-8

Ln 39, Col 1javascript

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.

List of contacts retrieved successfully

application/json

object *

Example

{
"0": {
  "id": "1234567890@c.us",
  "name": "John Doe",
  "pushname": "John"
  },
"1": {
  "id": "0987654321@lid",
  "name": "Business Contact",
  "pushname": "Business"
  }
}

Bad Request - Invalid Parameter Format

Unauthorized - Invalid or Missing Access Token

Command Palette

Search for a command to run...