List all groups (legacy)
curl --request GET \
--url https://api.wppfy.com/group/list \
--header 'token: <api-key>'import requests
url = "https://api.wppfy.com/group/list"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.wppfy.com/group/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/group/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/group/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.wppfy.com/group/list")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/group/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"JID": "jid8@g.us",
"OwnerJID": "1232@s.whatsapp.net",
"OwnerPN": "<string>",
"Name": "Support Group",
"NameSetAt": "2023-11-07T05:31:56Z",
"NameSetBy": "<string>",
"NameSetByPN": "<string>",
"Topic": "<string>",
"TopicID": "<string>",
"TopicSetAt": "2023-11-07T05:31:56Z",
"TopicSetBy": "<string>",
"TopicSetByPN": "<string>",
"TopicDeleted": true,
"IsLocked": true,
"IsAnnounce": true,
"AnnounceVersionID": "<string>",
"IsEphemeral": true,
"DisappearingTimer": 1,
"IsIncognito": true,
"IsParent": true,
"IsJoinApprovalRequired": true,
"LinkedParentJID": "<string>",
"IsDefaultSubGroup": true,
"DefaultMembershipApprovalMode": "<string>",
"GroupCreated": "2023-11-07T05:31:56Z",
"CreatorCountryCode": "<string>",
"ParticipantVersionID": "<string>",
"Participants": [
{
"JID": "<string>",
"LID": "<string>",
"PhoneNumber": "<string>",
"IsAdmin": true,
"IsSuperAdmin": true,
"DisplayName": "<string>",
"ImagePreview": "<string>",
"Error": 1,
"AddRequest": {
"Code": "<string>",
"Expiration": "2023-11-07T05:31:56Z"
},
"Username": "<string>"
}
],
"MemberAddMode": "",
"AddressingMode": "",
"OwnerCanSendMessage": true,
"OwnerIsAdmin": true,
"DefaultSubGroupId": "<string>",
"invite_link": "<string>",
"request_participants": "<string>",
"image_url": "<string>",
"image_preview_url": "<string>",
"picture_id": "<string>",
"picture_preview_id": "<string>",
"picture_empty_at": "2023-11-07T05:31:56Z",
"image_checked_at": "2023-11-07T05:31:56Z",
"image_preview_checked_at": "2023-11-07T05:31:56Z",
"parent_community": {
"jid": "<string>",
"name": "<string>",
"image_url": "<string>",
"image_preview_url": "<string>",
"default_subgroup_jid": "<string>"
},
"participant_profiles": [
{
"jid": "<string>",
"pn": "<string>",
"lid": "<string>",
"username": "<string>",
"display_name": "<string>",
"name": "<string>",
"image_url": "<string>",
"image_preview_url": "<string>",
"picture_id": "<string>",
"picture_preview_id": "<string>",
"is_admin": true,
"is_super_admin": true
}
],
"ParticipantCount": 1,
"request_participants_lid": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "Request timeout"
}{
"error": "<string>"
}Groups and Communities
List all groups (legacy)
Kept for existing integrations. Returns the group collection without pagination and may produce a large response. For new integrations, prefer POST /group/list.
Advanced options
noParticipants=true returns the list without members, as in the POST. force
may reuse a recent update. To query members, use
POST /group/info on the chosen group.
GET
/
group
/
list
List all groups (legacy)
curl --request GET \
--url https://api.wppfy.com/group/list \
--header 'token: <api-key>'import requests
url = "https://api.wppfy.com/group/list"
headers = {"token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {token: '<api-key>'}};
fetch('https://api.wppfy.com/group/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.wppfy.com/group/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.wppfy.com/group/list"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.wppfy.com/group/list")
.header("token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wppfy.com/group/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"groups": [
{
"JID": "jid8@g.us",
"OwnerJID": "1232@s.whatsapp.net",
"OwnerPN": "<string>",
"Name": "Support Group",
"NameSetAt": "2023-11-07T05:31:56Z",
"NameSetBy": "<string>",
"NameSetByPN": "<string>",
"Topic": "<string>",
"TopicID": "<string>",
"TopicSetAt": "2023-11-07T05:31:56Z",
"TopicSetBy": "<string>",
"TopicSetByPN": "<string>",
"TopicDeleted": true,
"IsLocked": true,
"IsAnnounce": true,
"AnnounceVersionID": "<string>",
"IsEphemeral": true,
"DisappearingTimer": 1,
"IsIncognito": true,
"IsParent": true,
"IsJoinApprovalRequired": true,
"LinkedParentJID": "<string>",
"IsDefaultSubGroup": true,
"DefaultMembershipApprovalMode": "<string>",
"GroupCreated": "2023-11-07T05:31:56Z",
"CreatorCountryCode": "<string>",
"ParticipantVersionID": "<string>",
"Participants": [
{
"JID": "<string>",
"LID": "<string>",
"PhoneNumber": "<string>",
"IsAdmin": true,
"IsSuperAdmin": true,
"DisplayName": "<string>",
"ImagePreview": "<string>",
"Error": 1,
"AddRequest": {
"Code": "<string>",
"Expiration": "2023-11-07T05:31:56Z"
},
"Username": "<string>"
}
],
"MemberAddMode": "",
"AddressingMode": "",
"OwnerCanSendMessage": true,
"OwnerIsAdmin": true,
"DefaultSubGroupId": "<string>",
"invite_link": "<string>",
"request_participants": "<string>",
"image_url": "<string>",
"image_preview_url": "<string>",
"picture_id": "<string>",
"picture_preview_id": "<string>",
"picture_empty_at": "2023-11-07T05:31:56Z",
"image_checked_at": "2023-11-07T05:31:56Z",
"image_preview_checked_at": "2023-11-07T05:31:56Z",
"parent_community": {
"jid": "<string>",
"name": "<string>",
"image_url": "<string>",
"image_preview_url": "<string>",
"default_subgroup_jid": "<string>"
},
"participant_profiles": [
{
"jid": "<string>",
"pn": "<string>",
"lid": "<string>",
"username": "<string>",
"display_name": "<string>",
"name": "<string>",
"image_url": "<string>",
"image_preview_url": "<string>",
"picture_id": "<string>",
"picture_preview_id": "<string>",
"is_admin": true,
"is_super_admin": true
}
],
"ParticipantCount": 1,
"request_participants_lid": "<string>"
}
]
}{
"error": "<string>"
}{
"error": "Request timeout"
}{
"error": "<string>"
}Authorizations
Query Parameters
Requests a list refresh. May reuse the last successful refresh during the local minimum interval of 20 seconds.
Use true to return the list without participants.
Response
List of groups retrieved successfully
Detailed list of groups
Show child attributes
Show child attributes
