curl --request POST \
--url https://api.wppfy.com/group/list \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"page": 1,
"pageSize": 50,
"limit": 123,
"offset": 0,
"search": "<string>",
"force": false,
"noParticipants": false
}
'{
"groups": [
{
"JID": "jid8@g.us",
"OwnerJID": "1232@s.whatsapp.net",
"Name": "Grupo de Suporte",
"NameSetAt": "2023-11-07T05:31:56Z",
"NameSetBy": "<string>",
"Topic": "<string>",
"IsLocked": true,
"IsAnnounce": true,
"AnnounceVersionID": "<string>",
"IsEphemeral": true,
"DisappearingTimer": 1,
"IsIncognito": true,
"IsParent": true,
"IsJoinApprovalRequired": true,
"LinkedParentJID": "<string>",
"IsDefaultSubGroup": true,
"GroupCreated": "2023-11-07T05:31:56Z",
"ParticipantVersionID": "<string>",
"Participants": [
"<unknown>"
],
"MemberAddMode": "admin_add",
"OwnerCanSendMessage": true,
"OwnerIsAdmin": true,
"DefaultSubGroupId": "<string>",
"invite_link": "<string>",
"request_participants": "<string>"
}
],
"pagination": {
"totalRecords": 123,
"pageSize": 123,
"currentPage": 123,
"totalPages": 123,
"hasNextPage": true,
"hasPreviousPage": true
}
}Returns a list of all groups available for the current WhatsApp instance, with options for filters and pagination via body (POST). The GET route continues for those who prefer direct listing without pagination.
curl --request POST \
--url https://api.wppfy.com/group/list \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"page": 1,
"pageSize": 50,
"limit": 123,
"offset": 0,
"search": "<string>",
"force": false,
"noParticipants": false
}
'{
"groups": [
{
"JID": "jid8@g.us",
"OwnerJID": "1232@s.whatsapp.net",
"Name": "Grupo de Suporte",
"NameSetAt": "2023-11-07T05:31:56Z",
"NameSetBy": "<string>",
"Topic": "<string>",
"IsLocked": true,
"IsAnnounce": true,
"AnnounceVersionID": "<string>",
"IsEphemeral": true,
"DisappearingTimer": 1,
"IsIncognito": true,
"IsParent": true,
"IsJoinApprovalRequired": true,
"LinkedParentJID": "<string>",
"IsDefaultSubGroup": true,
"GroupCreated": "2023-11-07T05:31:56Z",
"ParticipantVersionID": "<string>",
"Participants": [
"<unknown>"
],
"MemberAddMode": "admin_add",
"OwnerCanSendMessage": true,
"OwnerIsAdmin": true,
"DefaultSubGroupId": "<string>",
"invite_link": "<string>",
"request_participants": "<string>"
}
],
"pagination": {
"totalRecords": 123,
"pageSize": 123,
"currentPage": 123,
"totalPages": 123,
"hasNextPage": true,
"hasPreviousPage": true
}
}Page number for pagination (default 1)
Number of results per page (default 50, maximum 1000)
Optional alias for pageSize
Zero-based offset; if provided recalculates the page
Text to filter groups by name/JID
If set to true, forces the update of the group cache.
Useful to ensure that the latest information is retrieved.
If set to true, returns the list of groups without including participants.
Useful for optimizing the response when participant data is not needed.
List of groups retrieved successfully
Detailed list of groups
Show child attributes
Identificador único do grupo
"jid8@g.us"
JID do proprietário do grupo
"1232@s.whatsapp.net"
Nome do grupo
"Grupo de Suporte"
Data da última alteração do nome
JID do usuário que definiu o nome
Descrição do grupo
Indica se apenas administradores podem editar informações do grupo
true
Indica se apenas administradores podem enviar mensagens
Versão da configuração de anúncios
Indica se as mensagens são temporárias
Tempo em segundos para desaparecimento de mensagens
x >= 0Indica se o grupo é incognito
Indica se é um grupo pai (comunidade)
Indica se requer aprovação para novos membros
JID da comunidade vinculada
Indica se é um subgrupo padrão da comunidade
Data de criação do grupo
Versão da lista de participantes
Lista de participantes do grupo
Modo de adição de novos membros
admin_add, all_member_add Verifica se é possível você enviar mensagens
Verifica se você adminstrador do grupo
Se o grupo atual for uma comunidade, nesse campo mostrará o ID do subgrupo de avisos
Link de convite para entrar no grupo
Lista de solicitações de entrada, separados por vírgula
Show child attributes
Total groups found
Items per page
Current page
Total number of pages
Indicates if there is a next page
Indicates if there is a previous page