Pular para o conteúdo principal
GET
/
instances
/
{id}
/
group
/
list
Listar grupos
curl --request GET \
  --url https://api.vzaps.com/instances/{id}/group/list \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "success": true,
  "data": {
    "groups": [
      {
        "jid": "120363021234567890@g.us",
        "owner_jid": "5511999999999@s.whatsapp.net",
        "owner_pn": "5511999999999",
        "name": "Equipe Vendas",
        "topic": "Pedidos e follow-up",
        "topic_deleted": false,
        "is_locked": false,
        "is_announce": false,
        "is_ephemeral": false,
        "disappearing_timer": 0,
        "group_created": "2025-11-20T14:30:00Z",
        "participant_count": 2,
        "total_participants": 2,
        "is_admin": true,
        "invite_url": "https://chat.whatsapp.com/AbCdEfGhIjKlMnOpQrStUv",
        "participants": [
          {
            "jid": "5511999999999@s.whatsapp.net",
            "phone_number": "5511999999999@s.whatsapp.net",
            "lid": "",
            "is_admin": true,
            "is_super_admin": true,
            "display_name": "Maria",
            "error": 0
          },
          {
            "jid": "5511888888888@s.whatsapp.net",
            "phone_number": "5511888888888@s.whatsapp.net",
            "lid": "",
            "is_admin": false,
            "is_super_admin": false,
            "display_name": "Joao",
            "error": 0
          }
        ]
      }
    ],
    "user_id": 42,
    "instance_id": "VZ9K2M4N8P1Q3R5S7T0WABCD01EF"
  }
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

Identificador publico da instancia no formato gerado pela plataforma: prefixo VZ seguido de caracteres alfanumericos.

Exemplo:

"VZ9K2M4N8P1Q3R5S7T0WABCD01EF"

Parâmetros de consulta

page
integer
padrão:1
pageSize
integer
padrão:10

Resposta

200 - application/json

Grupos da conta

code
integer
obrigatório
success
boolean
obrigatório
data
object

Corpo em data GET /instances/{id}/group/list (lista paginada de grupos da sessao).