WhatsApp Groups API
Manage and retrieve information about the WhatsApp groups your instance belongs to.
Fetch groups list
Endpoint: GET /groups
Use this endpoint to retrieve all groups where your instance is currently a participant. This is essential for obtaining the id (Group JID) required to send messages to a specific group.
Query Parameters
instance(string): Your unique instance identifier.
- curl
- Axios
- Fetch
- Guzzle
- curl (PHP)
- requests
curl -X GET "https://api.communiktor.com/groups?instance=my-instance-1" \
-H "X-API-KEY: YOUR_API_KEY"
import axios from 'axios';
const url = 'https://api.communiktor.com/groups';
const config = {
headers: { 'X-API-KEY': 'YOUR_API_KEY' },
params: { instance: 'my-instance-1' }
};
axios.get(url, config)
.then(res => console.log(res.data))
.catch(err => console.error(err.response?.data || err.message));
const url = new URL('https://api.communiktor.com/groups');
url.searchParams.append('instance', 'my-instance-1');
const res = await fetch(url, {
method: 'GET',
headers: { 'X-API-KEY': 'YOUR_API_KEY' }
});
const data = await res.json();
console.log(data);
<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
$client = new Client(['base_uri' => 'https://api.communiktor.com']);
$response = $client->get('/groups', [
'headers' => [ 'X-API-KEY' => 'YOUR_API_KEY' ],
'query' => [ 'instance' => 'my-instance-1' ]
]);
echo $response->getBody();
<?php
$instance = "my-instance-1";
$url = "https://api.communiktor.com/groups?instance=" . urlencode($instance);
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [ 'X-API-KEY: YOUR_API_KEY' ],
CURLOPT_CUSTOMREQUEST => "GET"
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
import requests
url = 'https://api.communiktor.com/groups'
params = { 'instance': 'my-instance-1' }
headers = { 'X-API-KEY': 'YOUR_API_KEY' }
response = requests.get(url, params=params, headers=headers)
print(response.json())
Response format
{
"success": true,
"code": 200,
"message": "2 groups found",
"data": [
{
"id": "123456789@g.us",
"subject": "Company Announcements",
"size": 42
},
{
"id": "987654321@g.us",
"subject": "Support Team",
"size": 12
}
]
}