Skip to main content
GET
https://api.enviaai.app
/
v1
/
groups
Listar Grupos
curl --request GET \
  --url https://api.enviaai.app/v1/groups \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "[email protected]",
      "name": "Equipe de Vendas",
      "description": "Grupo para comunicação da equipe",
      "pictureUrl": "https://pps.whatsapp.net/...",
      "participantsCount": 25,
      "isAdmin": true,
      "createdAt": "2026-01-01T10:00:00.000Z"
    },
    {
      "id": "[email protected]",
      "name": "Clientes VIP",
      "description": null,
      "pictureUrl": null,
      "participantsCount": 150,
      "isAdmin": false,
      "createdAt": "2025-12-15T14:30:00.000Z"
    }
  ]
}

​
Query Parameters

​
instanceId
string
required
ID da instância

​
Response

​
data[].id
string
ID do grupo (JID)
​
data[].name
string
Nome do grupo
​
data[].description
string
Descrição do grupo
​
data[].participantsCount
number
Número de participantes
​
data[].isAdmin
boolean
Se você é admin

​
Exemplo

const groups = await client.groups.list({
  instanceId: 'inst_abc123'
});

groups.data.forEach(group => {
  console.log(`${group.name} (${group.participantsCount} membros)`);
});

{
  "success": true,
  "data": [
    {
      "id": "[email protected]",
      "name": "Equipe de Vendas",
      "description": "Grupo para comunicação da equipe",
      "pictureUrl": "https://pps.whatsapp.net/...",
      "participantsCount": 25,
      "isAdmin": true,
      "createdAt": "2026-01-01T10:00:00.000Z"
    },
    {
      "id": "[email protected]",
      "name": "Clientes VIP",
      "description": null,
      "pictureUrl": null,
      "participantsCount": 150,
      "isAdmin": false,
      "createdAt": "2025-12-15T14:30:00.000Z"
    }
  ]
}