Pular para o conteúdo principal
GET
/
group
/
list
Listar todos os grupos
curl --request GET \
  --url https://api.wppfy.com/group/list \
  --header 'token: <api-key>'
{
  "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>"
    }
  ]
}

Autorizações

​
token
string
header
obrigatório

Parâmetros de consulta

​
force
boolean
padrão:false

Se definido como true, força a atualização do cache de grupos. Útil para garantir que as informações mais recentes sejam recuperadas.

Comportamentos:

  • false (padrão): Usa informações em cache
  • true: Busca dados atualizados diretamente do WhatsApp
​
noparticipants
boolean
padrão:false

Se definido como true, retorna a lista de grupos sem incluir os participantes. Útil para otimizar a resposta quando não há necessidade dos dados dos participantes.

Comportamentos:

  • false (padrão): Retorna grupos com lista completa de participantes
  • true: Retorna grupos sem incluir os participantes

Resposta

Lista de grupos recuperada com sucesso

​
groups
object[]

Lista detalhada de grupos