# Listar grupos

Fonte: https://apiwpp.com/docs/api/conexoes/listar-grupos
Seção: Conexões
Atualizado em: 2026-09-28

`GET /connections/{id}/groups`

Os grupos de que o número pareado participa, consultados no WhatsApp na hora. A conexão precisa estar `open` (`400` caso contrário), e o provedor dela precisa suportar grupos (`501` caso contrário). Escopo necessário: `connections:read`.

## Cabeçalhos

| Nome | Obrigatório | Descrição |
| --- | --- | --- |
| `Authorization` | sim | `Bearer <chave de API>`; ou envie a chave em `X-Api-Key`. |

## Parâmetros de caminho

| Nome | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `id` | `string · uuid` | sim | Identificador da conexão (o número). |

## Exemplo de requisição

### cURL

```bash
curl https://api.apiwpp.com/connections/$CONNECTION_ID/groups \
  -H "Authorization: Bearer $API_KEY"
```

### Node.js

```javascript
const res = await fetch(`https://api.apiwpp.com/connections/${connectionId}/groups`, {
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
})
const data = await res.json()
```

### PHP

```php
$response = Http::withToken($apiKey)
    ->get("https://api.apiwpp.com/connections/{$connectionId}/groups");
```

### Python

```python
import requests

response = requests.get(
    f"https://api.apiwpp.com/connections/{connection_id}/groups",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
```

## Respostas

| Código | Erro | Descrição |
| --- | --- | --- |
| 200 |  | `groups`: cada grupo com `jid` (o JID do grupo, `…@g.us`), `subject` (o nome) e `size` (quantos participantes). |
| 400 |  | A conexão não está `open` (`Connection not ready (status: …)`): espere o `connection.status` `open` ou conecte-a de novo. |
| 400 | `FST_ERR_VALIDATION` | A requisição não segue o schema da operação (por exemplo, um `id` que não é um UUID); `message` diz o que está errado. |
| 401 |  | Sem chave de API, ou com uma chave desconhecida, revogada ou expirada. O corpo é `{"error": "Unauthorized"}`. |
| 402 | `subscription_inactive` | A organização dona da conexão não pode usar o WhatsApp agora: o período de teste acabou, ou uma fatura venceu e passou do prazo de carência. Pague para voltar a usar. |
| 403 |  | A chave não tem o escopo `connections:read`; a mensagem de erro cita o escopo que falta. |
| 404 |  | A conexão não existe ou não é de quem chama: a de outra pessoa responde exatamente como uma que não existe (`Connection not found`). |
| 429 |  | Requisições demais deste IP de origem, ou autenticações com falha demais: espere os segundos de `Retry-After`. Cabeçalhos: `Retry-After`. |
| 500 |  | O WhatsApp não respondeu à consulta dos grupos (`Failed to fetch groups`): tente de novo. |
| 501 | `unsupported_by_provider` | O provedor da conexão não faz esta operação: o provedor dela não lista grupos. |
| 503 |  | A instância do gateway que roda a conexão está mudando (um reinício, um failover) ou não responde: espere os segundos de `Retry-After` e tente de novo. Cabeçalhos: `Retry-After`. |

### 200 OK

```json
{
  "groups": [
    {
      "jid": "120363040000000001@g.us",
      "subject": "Equipe da barbearia",
      "size": 3
    }
  ]
}
```

## Detalhes

O `jid` de um grupo (`…@g.us`) serve como `to` em [POST /connections/{id}/send](https://apiwpp.com/docs/api/mensagens/enviar-mensagem). Os webhooks `group.joined`, `group.left` e `group.updated` avisam quando o número entra, sai ou quando um grupo muda.

Uma falha inesperada ao consultar o WhatsApp responde `500` (`Failed to fetch groups`): tente de novo.

Guia: [Enviar mensagens](https://apiwpp.com/docs/guias/enviar-mensagens).
