Pular para o conteúdo principal
GET
/
api
/
group
/
list
/
:instance
Listar Grupos
curl --request GET \
  --url https://api.example.com/api/group/list/:instance \
  --header 'token: <token>'
Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Lista todos os grupos da instância. Por padrão, retorna apenas metadados leves (nome, JID, descrição, criador, contagem). Passe includeMembers=true na query para incluir a lista completa de membros, neste caso o timeout da operação é estendido para 60s.

​
Exemplos

​
Listar (sem membros)

Retorna todos os grupos da instância apenas com metadados leves (nome, JID, descrição, criador, contagem). É o modo padrão, mais rápido em contas com muitos grupos. 
curl -X GET "https://ryzeapi.cloud/api/group/list/$Instance_Name" \
  -H "token: $Token_Instance"

​
Listar com membros

Adiciona includeMembers=true para incluir a lista completa de participantes de cada grupo. O timeout interno é estendido para 60s, útil quando você precisa de uma snapshot completa em uma única chamada. 
curl -X GET "https://ryzeapi.cloud/api/group/list/$Instance_Name?includeMembers=true" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

Retorna todos os grupos da instância em groups[], com meta.total indicando a quantidade. Cada item carrega metadados leves (name, groupJid, description, creatorJid, memberCount); o array members só vem populado quando includeMembers=true. Não há paginação, todos os grupos vêm em uma única resposta.
200 OK
{
  "success": true,
  "message": "2 Groups found",
  "groups": [
    {
      "name": "Time de Dev",
      "groupJid": "120363406289005073@g.us",
      "description": "Discussões técnicas",
      "creatorJid": "5511999999999@s.whatsapp.net",
      "memberCount": 3,
      "members": [
        { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
      ]
    }
  ],
  "meta": { "total": 2 }
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Headers

​
token
string
obrigatório
TokenAccount ou TokenInstance.

​
Query

​
includeMembers
boolean
padrão:"false"
Quando true, inclui a lista completa de membros de cada grupo.

​
Notas

  • O array members só aparece quando includeMembers=true.
  • Para uma conta com muitos grupos, use includeMembers=false e busque os membros sob demanda via GET /info.
  • Não há paginação, todos os grupos vêm em uma única resposta.

​
Erros

HTTPMensagem
400Instance is not connected to WhatsApp
404Instance not found
Envelope: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}