Chats list & overview
Get a list of all active chats (individuals and groups) with pagination support.
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
Consult the official documentation for detailed parameter descriptions.
Test endpoints in a sandbox environment before production.
Keep your API client library up to date.
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 stringstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | — | Field to sort by (e.g., id) Example: | |
string | — | Sort direction (ASC or DESC) Example: | |
number | — | Number of chats to return Example: | |
number | — | Number of chats to skip 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.
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
{
"success": true,
"message": "Operation completed successfully"
}Command Palette
Search for a command to run...