Skip to main content
GET
Retorna todos os grupos aos quais a instância conectada pertence, com opções para controlar o cache e o detalhamento dos participantes.

Opções de Listagem

Como funciona a listagem de grupos disponíveis.Dados retornados:
  • ID único de cada grupo (JID)
  • Nome do grupo
  • Descrição (se disponível)
  • Foto de perfil (URL)
  • Número total de participantes
  • Configurações do grupo (anúncios, restrições)
  • Lista completa de participantes (opcional)
Ideal para dashboards e sistemas de gerenciamento.
Gerenciamento de atualização dos dados de grupos.Modo cache (force=false):
  • Retorna dados armazenados localmente
  • Resposta mais rápida
  • Economiza recursos do servidor
  • Pode conter informações ligeiramente desatualizadas
Modo atualizado (force=true):
  • Busca dados diretamente do WhatsApp
  • Informações em tempo real
  • Maior tempo de resposta
  • Use quando precisar de dados precisos e atuais
Escolha o modo baseado na necessidade de atualização.
Controle da inclusão de dados de participantes.Com participantes (noparticipants=false):
  • Retorna lista completa de membros de cada grupo
  • Inclui informações de administradores
  • Resposta mais pesada
  • Ideal para análises detalhadas
Sem participantes (noparticipants=true):
  • Retorna apenas informações básicas do grupo
  • Resposta mais leve e rápida
  • Reduz uso de banda e processamento
  • Perfeito para listagens simples
Use noparticipants=true quando não precisar dos membros.
Situações comuns para listar grupos programaticamente.Aplicações:
  • Dashboards de monitoramento de grupos
  • Sistemas de backup e auditoria
  • Ferramentas de análise de participação
  • Seleção de grupos para envio de mensagens
  • Relatórios de gestão de comunidades
  • Sincronização com sistemas CRM
  • Automação de tarefas em múltiplos grupos

Authorization

string
required
Chave de autenticação da sua conexão, utilizada no header Authorization como Bearer Token.
Você encontra sua API Key no botão API da sua conexão no painel ZapClass.
A chave sempre começa com o prefixo zc_.
Exemplo: zc_6FrX2qjM4bHT9pR6cC0sD8wLkG3nE2tZfV5uN1aP

Query Parameters

boolean
Forçar atualização do cache de grupos.
true: Busca dados atualizados do WhatsApp
false: Usa informações em cache (padrão)
Exemplo: true
boolean
Omitir lista de participantes na resposta.
true: Retorna grupos sem participantes
false: Inclui lista completa de participantes (padrão)
Exemplo: true
Dica de Performance: Use noparticipants=true quando precisar apenas de informações básicas dos grupos. Isso reduz significativamente o tamanho da resposta e o tempo de processamento.