Listar chaves de API

GET/v1/instances/{id}/api-keysdesde M11token da instância ou admin

Quando usar

Listar chaves de API

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/api-keys" \
  -H "Authorization: Bearer $LITEZAP_TOKEN"

Node.js

const res = await fetch("http://localhost:8787/v1/instances/inst_7f3a9c2e5b1d4086/api-keys", {
  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/api-keys",
    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/api-keys", 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/api-keys', [
    '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 As chaves da instância (sem o segredo).

Campos de object

api_keys

APIKey[]

{
  "api_keys": [
    {
      "id": "key_5c1e9a7d3b2f4086",
      "instance_id": "inst_7f3a9c2e5b1d4086",
      "name": "painel do cliente",
      "scopes": [
        "read"
      ],
      "ip_allowlist": [],
      "created_at": "2026-10-18T09:00:00Z",
      "last_used_at": "2026-10-18T09:12:00Z"
    }
  ]
}

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: (sem equivalente). Veja Migrar da Z-API.

Outras operações de Plataforma: Operação em lote · Criar chave de API · Revogar chave de API · Gerar link de pareamento · Revogar links de pareamento · Uso da instância