Listar Instâncias
Retorna a listagem de todas as instâncias do WhatsApp vinculadas à sua conta empresarial.
{
"success": true,
"data": [
{
"id": "{ID_DA_SUA_INSTANCIA}",
"name": "Suporte Comercial",
"status": "CONNECTED",
"messages_sent": 1205,
"messages_failed": 12,
"created_at": "2026-06-07T10:16:03Z",
"updated_at": "2026-06-07T10:16:03Z"
}
],
"error": null
}As instâncias retornadas podem estar em diferentes estados como CONNECTED, DISCONNECTED ou INITIALIZING. Certifique-se de validar o campo status antes de tentar enviar mensagens.
Headers
Token no formato Bearer <token_empresa>.
Defina como application/json.
Query Parameters
Filtrar instâncias por status (Valores possíveis: CONNECTED, DISCONNECTED, WAITING_QR, ERROR, TIMEOUT, CONNECTING, CONNECT_FAILURE, BANNED, CONFLICT, LOGGED_OUT, STREAM_ERROR, CORRUPTED).
Número máximo de registros a retornar (Padrão: 100).
Response Schema
application/jsonIndica se a requisição obteve sucesso.
Mensagem de erro caso success seja falso.
Lista de instâncias retornadas. Pode ser null caso não haja dados.
Atributos do Objeto
ID único da instância (UUIDv7).
Nome identificador da instância.
Status atual da conexão (Valores possíveis: CONNECTED, DISCONNECTED, WAITING_QR, ERROR, TIMEOUT, CONNECTING, CONNECT_FAILURE, BANNED, CONFLICT, LOGGED_OUT, STREAM_ERROR, CORRUPTED).
Total de mensagens enviadas com sucesso.
Total de mensagens que falharam no envio.
Data de criação da instância.