Consultar instância

GET/v1/instances/{id}desde M1token da instância ou admin

Quando usar

Estado atual e número conectado. Os estados mudam de forma assíncrona; use esta rota para acompanhar (polling) até haver eventos (marco 3).

Autenticação

Aceita o token da instância (só a própria instância) ou o token admin. Um token de outra instância recebe 403 forbidden (ou 404 not_found em webhooks de outra instância).

Parâmetros

Caminho

Nome	Tipo	Descrição
idobrigatório	string	Id da instância (inst_...).

Exemplo

cURL

curl -s "$LITEZAP_URL/v1/instances/$ID" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086", {
  headers: { Authorization: `Bearer ${process.env.LITEZAP_TOKEN}` },
});
console.log(res.status, res.status === 204 ? "" : await res.json());

Python

import os
import requests

r = requests.get(
    "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_TOKEN']}"},
    timeout=150,
)
print(r.status_code, r.json() if r.content else "")

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "os"
)

func main() {
  req, _ := http.NewRequest("GET", "http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_TOKEN"))
  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()
  out, _ := io.ReadAll(resp.Body)
  fmt.Println(resp.Status, string(out))
}

PHP

<?php
require 'vendor/autoload.php'; // composer require guzzlehttp/guzzle

$client = new GuzzleHttp\Client(['base_uri' => 'http://localhost:8787']);
$res = $client->request('GET', '/v1/instances/inst_7f3a9c2e5b1d4086', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_TOKEN')],
    'http_errors' => false,
]);
echo $res->getStatusCode(), ' ', $res->getBody(), PHP_EOL;

Nos exemplos, LITEZAP_URL é a URL base (ex.: http://localhost:8787) e o token vem deLITEZAP_TOKEN (instância) ou LITEZAP_ADMIN_TOKEN.

Resposta

200 A instância.

Campos de Instance

id	string
name	string
state	InstanceState
state_reason	string	Ex.: proxy_unreachable, temp_banned:<duração>.
phone	string	Número conectado (depois do pareamento).
tags	string[]	Etiquetas (marco 11).
ip_allowlist	string[]	CIDRs de onde o token da instância é aceito; vazio = qualquer (marco 11).
created_at	string
updated_at	string

{
  "id": "inst_7f3a9c2e5b1d4086",
  "name": "atendimento",
  "state": "connected",
  "phone": "5511999999999",
  "created_at": "2026-10-17T13:45:00Z",
  "updated_at": "2026-10-17T13:47:12Z"
}

Erros

Código	HTTP	Retentável	O que fazer
unauthorized	401	não	Envie Authorization: Bearer <token> válido.
forbidden	403	não	Use o token certo (admin, ou o da própria instância).
instance_not_found	404	não	Confira o id da instância.

Todo erro usa o envelope {"error":{"code","message","retryable"}}. Tabela completa em Erros.

Equivalente na Z-API: Status da instância / Dados da instância. Veja Migrar da Z-API.

Outras operações de Instâncias: Listar instâncias · Criar instância · Editar instância · Apagar instância · Iniciar worker · Parar worker · Reiniciar worker · Desconectar número · Rotacionar token da instância