Get Chats Overview

Retrieve a summary of all active chats and messages metadata.

GET

https://api.wawp.net/v2/chats/overview?instance_id=123456789&access_token=123456789

Authentication Required

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

Log In

Test /v2/chats/overview endpoint

Supports

GET

No query parameters required

This endpoint doesn't expect data in the URL.

Performance Tip

Use the overview for the initial load, then use Webhooks to patch the UI state. Avoid constant polling for the entire list.

Best practices

Store the overview in a local cache (like Redux or a Map) for instant UI transitions.
Sort the results client-side by timestamp to ensure the most recent conversations are always at the top.
Use the unreadCount to drive 'Notification Badges' in your system's navigation.

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:

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/chats/overview";
3const params = new URLSearchParams({
4  "instance_id": "123456789",
5  "access_token": "123456789"
6}).toString();
7
8
9fetch(`${baseUrl}${endpoint}${params ? '?' + params : ''}`, {
10  method: "GET",
11  headers: { "Content-Type": "application/json" },
12  
13})
14  .then(async (response) => {
15    if (response.ok) {
16      const data = await response.json();
17      console.log("Success:", data);
18      return data;
19    }
20    
21    // Error Handling
22    if (response.status === 400) {
23      console.error("Error 400: Bad Request - Missing Required Parameter(s)");
24    }
25    if (response.status === 400) {
26      console.error("Error 400: Bad Request (XML Format)");
27    }
28    if (response.status === 400) {
29      console.error("Error 400: Bad Request (Plain Text)");
30    }
31    if (response.status === 401) {
32      console.error("Error 401: Unauthorized - Invalid or Missing Access Token");
33    }
34    if (response.status === 401) {
35      console.error("Error 401: Unauthorized (XML Format)");
36    }
37    if (response.status === 404) {
38      console.error("Error 404: Not Found - Session Does Not Exist");
39    }
40    if (response.status === 404) {
41      console.error("Error 404: Not Found (XML Format)");
42    }
43    if (response.status === 500) {
44      console.error("Error 500: Internal Server Error - Unexpected Failure");
45    }
46    if (response.status === 500) {
47      console.error("Error 500: Internal Server Error (HTML)");
48    }
49    if (response.status === 502) {
50      console.error("Error 502: Bad Gateway - Connection Failed to Upstream");
51    }
52    if (response.status === 502) {
53      console.error("Error 502: Bad Gateway (XML Format)");
54    }
55
56    const errorText = await response.text();
57    console.error(`Error ${response.status}: ${errorText}`);
58  })
59  .catch((error) => console.error("Network Error:", error));

Interactive SamplesUTF-8

Ln 59, 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.

Overview retrieved successfully.

4 Variants

Type:

Scenario:

application/json

object *

Example

{
"0": {
  "id": "447441429009@c.us",
  "name": "John Doe",
  "unreadCount": 5,
  "lastMessage": {
    "id": "ABC123",
    "body": "Hello!",
    "timestamp": 1722170400
    }
  }
}

Bad Request - Missing Required Parameter(s)

3 Variants

Unauthorized - Invalid or Missing Access Token

2 Variants

Command Palette

Search for a command to run...