Saltar al contenido principal
GET
/
api
/
group
/
list
/
:instance
Listar grupos
curl --request GET \
  --url https://api.example.com/api/group/list/:instance \
  --header 'token: <token>'

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.

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"

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

​
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

​
instance
string
requerido
Nombre de la instancia.

​
Cabeceras

​
token
string
requerido
TokenAccount o TokenInstance.

​
Query

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

HTTPMensaje
400Instance is not connected to WhatsApp
404Instance not found
Envoltorio: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}