Skip to main content
GET
/
v1
/
whatsapp
/
instances
/
{instanceId}
/
groups
Listar grupos
curl --request GET \
  --url https://api.notifique.dev/v1/whatsapp/instances/{instanceId}/groups \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "120363295648424210@g.us",
      "name": "Meu Grupo",
      "participantsCount": 5,
      "owner": "5511999999999@s.whatsapp.net",
      "creation": 1699000000
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 5
  }
}

Authorizations

​
Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Path Parameters

​
instanceId
string
required

ID da instância no workspace.

Query Parameters

​
page
integer
default:1

Página da listagem (a partir de 1).

​
limit
integer
default:20

Quantidade por página (máx. 100).

Required range: x <= 100

Response

Lista de grupos (paginada) ou indicação de que a lista está sendo carregada.

​
success
boolean
Example:

true

​
loading
boolean

Quando true, a lista ainda está sendo obtida; data virá vazio — tente novamente em alguns segundos.

​
message
string

Mensagem quando loading é true.

​
data
object[]
​
pagination
object