Pular para o conteúdo principal
GET
/
api
/
instances
/
{instanceId}
/
groups
Listar grupos
curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "[email protected]",
    "subject": "Team Chat",
    "participants": [
      {
        "id": "[email protected]",
        "admin": "admin"
      }
    ],
    "creation": 1707350400,
    "description": "<string>",
    "pictureUrl": "<string>"
  }
]

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

​
instanceId
string<uuid>
obrigatório

UUID da instância WhatsApp

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

Parâmetros de consulta

​
limit
number
padrão:50

Número máximo de itens a retornar

​
offset
number
padrão:0

Número de itens a pular

Resposta

List of groups

​
id
string
obrigatório

JID do grupo

Exemplo:

"[email protected]"

​
subject
string
obrigatório

Assunto/título do grupo

Exemplo:

"Team Chat"

​
participants
object[]
obrigatório

Membros do grupo

​
creation
number
obrigatório

Timestamp de criação

Exemplo:

1707350400

​
description
string

Texto de descrição do grupo

​
pictureUrl
string

URL da imagem do grupo