Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
groups
Buscar grupos
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/groups \
  --header 'Client-Token: <api-key>'
{
  "isGroup": true,
  "name": "<string>",
  "phone": "<string>",
  "unread": "<string>",
  "lastMessageTime": "<string>",
  "isMuted": "<string>",
  "archived": true,
  "pinned": true
}

​
Conceituação

Este método é responsável por retornar todos os grupos.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
page
integer
obrigatório
Utilizado para paginação, informe a página de grupos que quer buscar
​
pageSize
integer
obrigatório
Especifica o tamanho do retorno de grupos por página

​
Response

​
200

​
isGroup
boolean
Indica se é um grupo ou não
​
name
string
Nome atribuído ao chat
​
phone
string
ID/Phone do grupo
​
unread
string
Número de mensagens não lidas no chat
​
lastMessageTime
string
Timestamp com a data e hora da última interação com o chat
​
isMuted
string
0 ou 1 indica se você silenciou ou não este chat
​
archived
boolean
Indica se o chat está arquivado
​
pinned
boolean
Indica se o chat está fixado
[
  {
    "isGroup": true,
    "name": "Grupo teste",
    "phone": "120263358412332916-group",
    "unread": "0",
    "lastMessageTime": "1730918668000",
    "isMuted": "0",
    "isMarkedSpam": "false",
    "archived": "false",
    "pinned": "false",
    "muteEndTime": null,
    "messagesUnread": "0"
  }
]

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.