KernosDevelopers
Sair
Referência Eventos › Listar
Eventos › Listar

Lista os eventos públicos desde o último lido, do mais antigo para o mais novo

GET/v1/events

O mesmo corpo que o webhook entrega. Sem after, as últimas 24 horas; com ele, o que veio depois daquele evento. next_after é o after da próxima consulta, e has_more diz se ela já tem o que ler. A chave com CDs vê só o fato sem CD ou de um CD dela.

Ação da chave: event.list

Quem cria a chave escolhe as ações que ela abre; sem esta, a rota recusa com api_key_action_not_granted.

Parâmetros da consulta

after uuid

O id do último evento lido (next_after da consulta anterior).

limit integer ou string

De 1 a 200; 50 por padrão.

type string

Um ou mais tipos de evento públicos, separados por vírgula. Sem ele, todos.

Devolve

O data do envelope { ok, data, error, error_code, field, trace_id }:

events lista de objeto OBRIGATÓRIO
6 campos
created_at data e hora OBRIGATÓRIO
data objeto, ou nulo OBRIGATÓRIO

O mesmo data do webhook do tipo.

id uuid OBRIGATÓRIO

O id do evento: o mesmo do Kernos-Event-Id do webhook.

object objeto OBRIGATÓRIO
2 campos
id uuid
type string
tenant string OBRIGATÓRIO

O endereço da empresa (minha-empresa).

type string OBRIGATÓRIO

A ação pública (shipment.dispatch, pix.paid…).

has_more boolean OBRIGATÓRIO
limit integer OBRIGATÓRIO
next_after uuid, ou nulo OBRIGATÓRIO

Recusas

HTTP 400 · Pedido mal formado

invalid_limit HTTP 400limit fora da faixa: de 1 a 200.
invalid_offset HTTP 400offset inválido: um inteiro de zero para cima.
version_unknown HTTP 400A Kernos-Version pedida não existe. Use uma das versões declaradas no cabeçalho, ou não o mande.

HTTP 401 · Sem credencial válida

api_key_expired HTTP 401A chave venceu. Gire a chave no painel e use a nova.
api_key_wrong_environment HTTP 401A chave é do outro ambiente: ksk_test_ vai em https://stag.kernos.com.br, ksk_live_ em https://api.kernos.com.br.
unauthenticated HTTP 401Credencial ausente, inválida ou expirada.

HTTP 403 · Sem permissão

agent_token_out_of_scope HTTP 403O token de agente (kat_) só vale na porta MCP. Para a API, use o token de sessão ou uma chave de integração.
api_key_action_not_granted HTTP 403A chave não tem esta ação. Edite as ações da chave no painel.
api_key_out_of_scope HTTP 403A chave só vale nas rotas do contrato público.
depot_out_of_reach HTTP 403Quem chama não alcança o CD deste objeto. Peça alcance ao CD ou use outra credencial.
forbidden_role HTTP 403O papel de quem chama nesta empresa não permite esta ação.
module_not_subscribed HTTP 403A empresa não assina o módulo desta rota.
tenant_mismatch HTTP 403A credencial não pertence à empresa do endereço chamado.
tenant_unavailable HTTP 403A empresa está indisponível no momento.

HTTP 422 · Não processável

invalid_cursor HTTP 422O after não é um evento desta empresa. Use o next_after da consulta anterior; eventos com mais de 90 dias saem do anel.
invalid_event_type HTTP 422Um dos tipos não é um evento público. Use os nomes do contrato, separados por vírgula (shipment.dispatch,pix.paid).

HTTP 429 · Muitos pedidos

rate_limited HTTP 429Muitos pedidos por segundo com esta chave. Espere o Retry-After, em segundos, e tente de novo.
curlNodePythonPHPJavaC#GoRust
Lista os eventos públicos desde o último lido, do mais antigo para o mais novo
curl -X GET "https://stag.kernos.com.br/v1/events?limit=20" \
  -H "Authorization: Bearer ksk_test_…" \
  -H "Kernos-Version: 2026-10-03"
Resposta · 200 (a forma, sem dado real)
{
  "ok": true,
  "data": {
    "events": [
      {
        "created_at": "2026-10-03T12:00:00Z",
        "data": {},
        "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
        "object": {
          "id": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50",
          "type": "…"
        },
        "tenant": "…",
        "type": "…"
      }
    ],
    "has_more": true,
    "limit": 0,
    "next_after": "3f1e0c8a-5b7d-4c21-9a3e-0b1c2d3e4f50"
  },
  "error": null,
  "error_code": null,
  "field": null,
  "trace_id": null
}
Ambiente

ksk_test_ fala com https://stag.kernos.com.br; ksk_live_, com https://api.kernos.com.br. O prefixo da chave escolhe o endereço.