Pular para o conteúdo

Listar conexões

GET/connections

As conexões dos projetos ativos de quem chama, das mais novas para as mais antigas, cada uma com o status atual. As conexões com status failed (falha permanente, por exemplo um número banido) ficam de fora, a menos que includeFailed=true. Escopo necessário: connections:read.

Ver em Markdown

Parâmetros de consulta

includeFailedboolean

Inclui as conexões com status failed (falha permanente). Padrão: false.

padrão: false

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200As conexões (connections), das mais novas para as mais antigas, e quantas são (count).
400FST_ERR_VALIDATIONA requisição não segue o schema da operação (por exemplo, um id que não é um UUID); message diz o que está errado.
401Sem chave de API, ou com uma chave desconhecida, revogada ou expirada. O corpo é {"error": "Unauthorized"}.
403A chave não tem o escopo connections:read; a mensagem de erro cita o escopo que falta.
429Requisições demais deste IP de origem, ou autenticações com falha demais: espere os segundos de Retry-After.Cabeçalho: Retry-After

Detalhes

status é o status ao vivo quando a instância que responde roda a conexão (connecting, open, close ou passkey_required); senão, é o último gravado, em minúsculas: pending, connecting, open, close, failed ou passkey_required. Para um número só, GET /connections/{id}/qr sempre responde o status ao vivo.

externalId é o identificador que você deu à conexão ao criá-la; lastHeartbeat é a última vez que o gateway confirmou que o socket responde, e lastConnectedAt, a última vez que a conexão abriu.

Guia: Projetos e conexões

Esta página ajudou? · Atualizado em 28 set 2026