> ## 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

> Devuelve los grupos vinculados a una comunidad, incluyendo el Grupo de Anuncios

**Auth:** `TokenAccount` o `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sí

## Descripción

Lista los subgrupos de una comunidad. El **Grupo de Anuncios** se identifica por la bandera `isDefaultSubGroup: true`. A diferencia de los otros endpoints, esta ruta requiere un **JID** en `?communityJid=` (no acepta código / enlace).

## Ejemplos

### Listar subgrupos

Consulta los subgrupos de la comunidad `120363406289005073@g.us` pasando el JID completo (con el sufijo `@g.us`) en el 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>

### Sin el sufijo @g.us

Misma consulta, pero pasando solo el ID numérico en `communityJid`. El servicio agrega automáticamente `@g.us` antes de resolver la comunidad.

<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>

## Respuesta exitosa

Devuelve `communityJid` (ya normalizado con el sufijo `@g.us`) y el array `subgroups` con cada grupo vinculado en el que el bot participa. Cada elemento lleva `jid`, `name` y la bandera `isDefaultSubGroup` que identifica el **Grupo de Anuncios** de la comunidad. El `message` lleva el conteo (`"N subgroup(s) found"`) y el array viene vacío cuando no se encuentra ningún subgrupo.

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

## Parámetros de ruta

<ParamField path="instance" type="string" required>
  Nombre de la instancia.
</ParamField>

## Cabeceras

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

## Query

<ParamField query="communityJid" type="string" required>
  JID `@g.us` de la comunidad. Si omites el sufijo, el servicio agrega automáticamente `@g.us`.
</ParamField>

## Notas

<Note>
  * El listado **solo devuelve los subgrupos en los que está el bot**, si el bot está solo en el padre pero no en el subgrupo X, X no aparece en la lista.
  * La propagación de nuevas vinculaciones puede demorar 1-3s, un `GET` justo después de `POST /link` puede devolver temporalmente la lista sin el grupo recién vinculado.
  * El **Grupo de Anuncios** siempre aparece con `isDefaultSubGroup: true`. Filtra del lado del cliente si necesitas excluirlo del listado.
</Note>

## Errores

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

Envoltorio:

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

## Siguiente

<CardGroup cols={2}>
  <Card title="Vincular grupos" icon="link" href="/es/api/communities/link">
    Agrega nuevos subgrupos.
  </Card>

  <Card title="Desvincular grupos" icon="link-slash" href="/es/api/communities/unlink">
    Elimina subgrupos de la comunidad.
  </Card>
</CardGroup>