> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar subgrupos

> Retorna grupos vinculados a uma comunidade, incluindo o Grupo de Anúncios

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

## Descrição

Lista os subgrupos de uma comunidade. O **Grupo de Anúncios** é identificado pelo flag `isDefaultSubGroup: true`. Diferente dos demais endpoints, esta rota exige **JID** em `?communityJid=` (não aceita código / link).

## Exemplos

### Listar subgrupos

Consulta os subgrupos da comunidade `120363406289005073@g.us` passando o JID completo (com sufixo `@g.us`) na query string.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/community/listSubGroups/$Instance_Name?communityJid=120363406289005073@g.us" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/community/listSubGroups/${process.env.Instance_Name}?communityJid=120363406289005073@g.us`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/community/listSubGroups/{os.environ['Instance_Name']}?communityJid=120363406289005073@g.us",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/community/listSubGroups/"+os.Getenv("Instance_Name")+"?communityJid=120363406289005073@g.us", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Sem sufixo @g.us

Mesma consulta, mas passando apenas o ID numérico em `communityJid`. O serviço adiciona `@g.us` automaticamente antes de resolver a comunidade.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/community/listSubGroups/$Instance_Name?communityJid=120363406289005073" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/community/listSubGroups/${process.env.Instance_Name}?communityJid=120363406289005073`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/community/listSubGroups/{os.environ['Instance_Name']}?communityJid=120363406289005073",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/community/listSubGroups/"+os.Getenv("Instance_Name")+"?communityJid=120363406289005073", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

Retorna `communityJid` (já normalizado com sufixo `@g.us`) e o array `subgroups` com cada grupo vinculado em que o bot participa. Cada item traz `jid`, `name` e o flag `isDefaultSubGroup` que identifica o **Grupo de Anúncios** da comunidade. O `message` traz a contagem (`"N subgroup(s) found"`) e o array vem vazio quando nenhum subgrupo é encontrado.

```json 200 OK theme={null}
{
  "success": true,
  "message": "2 subgroup(s) found",
  "communityJid": "120363406289005073@g.us",
  "subgroups": [
    {
      "jid": "120363406289005074@g.us",
      "name": "Anúncios",
      "isDefaultSubGroup": true
    },
    {
      "jid": "120363406289005075@g.us",
      "name": "Geral",
      "isDefaultSubGroup": false
    }
  ]
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

## Query

<ParamField query="communityJid" type="string" required>
  JID `@g.us` da comunidade. Se omitir o sufixo, o serviço adiciona `@g.us` automaticamente.
</ParamField>

## Notas

<Note>
  * A listagem **só retorna subgrupos em que o bot está**, se o bot participa apenas do parent mas não de um subgrupo X, X não aparece na lista.
  * A propagação de novas vinculações pode levar 1-3s, um `GET` logo após `POST /link` pode retornar a lista sem o grupo recém-vinculado temporariamente.
  * O **Grupo de Anúncios** sempre aparece com `isDefaultSubGroup: true`. Filtre no cliente se precisar excluir-lo da listagem.
</Note>

## Erros

| HTTP | Mensagem                                   |
| ---- | ------------------------------------------ |
| 400  | `communityJid query parameter is required` |
| 400  | `invalid community JID: <reason>`          |
| 400  | `Instance is not connected to WhatsApp`    |
| 500  | `failed to get groups: <reason>`           |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "communityJid query parameter is required" }
}
```

## Próximo

<CardGroup cols={2}>
  <Card title="Vincular grupos" icon="link" href="/pt/api/communities/link">
    Adicionar novos subgrupos.
  </Card>

  <Card title="Desvincular grupos" icon="link-slash" href="/pt/api/communities/unlink">
    Remover subgrupos da comunidade.
  </Card>
</CardGroup>