Listar grupos

GET

api

group

list

:instance

Listar grupos

curl --request GET \
  --url https://api.example.com/api/group/list/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/group/list/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Descripción

Lista cada grupo al que pertenece la instancia. De forma predeterminada, solo se devuelven metadatos ligeros (nombre, JID, descripción, creador, recuento). Pasa includeMembers=true en la query para incluir la lista completa de miembros, al hacerlo, el timeout de la operación se extiende a 60s.

Ejemplos

Listar (sin miembros)

Devuelve cada grupo de la instancia con metadatos ligeros únicamente (nombre, JID, descripción, creador, recuento). Es el modo predeterminado y el más rápido para cuentas con muchos grupos.

curl -X GET "https://ryzeapi.cloud/api/group/list/$Instance_Name" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/group/list/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/list/{os.environ['Instance_Name']}",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/list/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Listar con miembros

Agrega includeMembers=true para incluir la lista completa de participantes de cada grupo. El timeout interno se extiende a 60s, útil cuando necesitas un snapshot completo en una sola llamada.

curl -X GET "https://ryzeapi.cloud/api/group/list/$Instance_Name?includeMembers=true" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/group/list/${process.env.Instance_Name}?includeMembers=true`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/list/{os.environ['Instance_Name']}?includeMembers=true",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/list/"+os.Getenv("Instance_Name")+"?includeMembers=true", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Respuesta exitosa

Devuelve cada grupo de la instancia bajo groups[], con meta.total reportando el recuento. Cada elemento lleva metadatos ligeros (name, groupJid, description, creatorJid, memberCount); el array members se completa solo cuando includeMembers=true. No hay paginación, todos los grupos vienen en una sola respuesta.

200 OK

{
  "success": true,
  "message": "2 Groups found",
  "groups": [
    {
      "name": "Dev Team",
      "groupJid": "120363406289005073@g.us",
      "description": "Technical discussions",
      "creatorJid": "5511999999999@s.whatsapp.net",
      "memberCount": 3,
      "members": [
        { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
      ]
    }
  ],
  "meta": { "total": 2 }
}

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Query

boolean

predeterminado:"false"

Cuando es true, incluye la lista completa de miembros de cada grupo.

Notas

El array members solo aparece cuando includeMembers=true.
Para cuentas con muchos grupos, usa includeMembers=false y obtén los miembros bajo demanda mediante GET /info.
No hay paginación, todos los grupos vienen en una sola respuesta.

Errores

HTTP	Mensaje
400	`Instance is not connected to WhatsApp`
404	`Instance not found`

Envoltorio:

{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Descripción

Ejemplos

Listar (sin miembros)

Listar con miembros

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores

​Descripción

​Ejemplos

​Listar (sin miembros)

​Listar con miembros

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Query

​Notas

​Errores

Descripción

Ejemplos

Listar (sin miembros)

Listar con miembros

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores