curl --request POST \
  --url https://api.wppfy.com/group/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "search": "Suporte",
  "limit": 50,
  "offset": 0,
  "noParticipants": true
}
'

{
  "groups": [
    {
      "JID": "jid8@g.us",
      "OwnerJID": "1232@s.whatsapp.net",
      "OwnerPN": "<string>",
      "Name": "Grupo de Suporte",
      "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>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true,
    "nextOffset": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "Request timeout"
}

{
  "error": "<string>"
}

Grupos e Comunidades

Listar grupos em páginas (recomendado)

Use esta operação para buscar grupos e escolher qual abrir. Prefira uma página de resumos sem a lista de membros; consulte POST /group/info quando precisar dos detalhes de um grupo.

Uso recomendado

Envie search, limit e offset, com noParticipants=true. O padrão de página é 50 e o máximo é 1000. A busca considera nome, JID, descrição do grupo e nome da comunidade à qual ele pertence. A resposta contém groups e pagination.

Opções avançadas e compatibilidade

O default HTTP de noParticipants continua false para preservar integrações existentes. O exemplo recomendado usa true explicitamente.
Para participantes e perfis completos, consulte somente o grupo selecionado em POST /group/info.
force solicita atualização do WhatsApp. Normalmente basta deixar a API atualizar quando necessário; não use force em polling contínuo.

Uma atualização remota da lista ainda pode receber participantes do WhatsApp; noParticipants=true evita carregá-los na leitura da página e enviá-los na resposta.

POST

group

list

curl --request POST \
  --url https://api.wppfy.com/group/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "search": "Suporte",
  "limit": 50,
  "offset": 0,
  "noParticipants": true
}
'

{
  "groups": [
    {
      "JID": "jid8@g.us",
      "OwnerJID": "1232@s.whatsapp.net",
      "OwnerPN": "<string>",
      "Name": "Grupo de Suporte",
      "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>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true,
    "nextOffset": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "Request timeout"
}

{
  "error": "<string>"
}

Autorizações

token

string

header

obrigatório

Corpo

application/json

limit

integer

padrão:50

Quantidade maxima de resultados por pagina (padrao 50, maximo 1000)

Intervalo obrigatório: 1 <= x <= 1000

offset

integer

padrão:0

Deslocamento base zero

string

Busca por nome, tópico, JID ou nome da comunidade pai.

force

boolean

padrão:false

Avançado: solicita atualização remota. Não é necessário no fluxo normal; não use em polling contínuo.

noParticipants

boolean

padrão:false

Compatibilidade: true retorna resumos sem membros, como no exemplo recomendado. O default HTTP continua false.

Resposta

Lista de grupos recuperada com sucesso

groups

object[]

Lista detalhada de grupos

Show child attributes

pagination

object

Show child attributes

Instancia

CRM

Proxy

Perfil

Enviar Mensagem

Mensagem Async

Ações na mensagem e Buscar

Grupos e Comunidades

Newsletters e Canais

Server-Sent Events (SSE)

Bloqueios

Etiquetas

Chats

Contatos

Chamadas

Integração Chatwoot

Business

Respostas Rápidas