Listar instâncias

GET/v1/instancesdesde M1token admin

Quando usar

Lista as instâncias em ordem de criação. Sem limit, devolve todas (como antes do marco 11). Com limit, pagina: siga next_cursor até ele não vir mais. Os filtros (marco 11) se combinam.

Autenticação

Exige o token admin. Com um token de instância a resposta é 403 forbidden.

Parâmetros

Query

Nome	Tipo	Descrição
state	string	Um ou mais estados separados por vírgula (connected,qr_pending).
tag	string	Só instâncias com esta etiqueta.
q	string	Trecho do nome ou do id (sem diferenciar maiúsculas).
limit	integer	Itens por página (1 a 500). Omitido: todas, sem paginação.
cursor	string	next_cursor da página anterior (opaco).

Exemplo

cURL

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

Node.js

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

Python

import os
import requests

r = requests.get(
    "http://localhost:8787/v1/instances",
    headers={"Authorization": f"Bearer {os.environ['LITEZAP_ADMIN_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", nil)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("LITEZAP_ADMIN_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', [
    'headers' => ['Authorization' => 'Bearer ' . getenv('LITEZAP_ADMIN_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 As instâncias (uma página, com limit).

Campos de object

instances	Instance[]
next_cursor	string	Presente quando há próxima página (só com limit).

{
  "instances": [
    {
      "id": "inst_7f3a9c2e5b1d4086",
      "name": "atendimento",
      "state": "connected",
      "phone": "5511999999999",
      "tags": [
        "vip"
      ],
      "ip_allowlist": [],
      "created_at": "2026-10-17T13:45:00Z",
      "updated_at": "2026-10-17T13:47:12Z"
    }
  ],
  "next_cursor": "MjAyNi0xMC0xN1QxMzo0NTowMC4wMDAwMDAwMDBafGluc3RfN2YzYTljMmU1YjFkNDA4Ng"
}

Erros

Código	HTTP	Retentável	O que fazer
validation_failed	400	não	Corrija o corpo ou os parâmetros; a message diz o campo.
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).

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

Equivalente na Z-API: Listar instâncias (parceiros). Veja Migrar da Z-API.

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