Pular para o conteúdo

Listar projetos

GET/tenants

Lista os projetos que a credencial alcança, do mais recente ao mais antigo, com o plano da organização e o número de conexões de cada um. Uma chave de API pertence a um único projeto, então a lista traz só ele. Escopo necessário: connections:read.

Ver em Markdown

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200Os projetos em tenants, do mais recente ao mais antigo, cada um com plan e connectionCount, e o total em count.
401Sem chave de API, ou com uma chave desconhecida, revogada ou expirada. A chave de um projeto desativado também responde 401.
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. Veja Limites.Cabeçalho: Retry-After

Detalhes

O plano e a assinatura são da organização, não do projeto: planId, subscriptionStatus, trialEndsAt e currentPeriodEnd são os da organização dona, e plan traz os limites do plano (maxConnections, maxMessagesDay, maxMessagesMonth, em que -1 é ilimitado) e o preço mensal em centavos (monthlyPriceCents, em que -1 é preço sob consulta).

As credenciais do webhook nunca voltam nas respostas: hasWebhookSecret diz se há um segredo de assinatura, e webhookHeaderNames traz só os nomes dos cabeçalhos personalizados. maxPerMinute, maxPerHour e maxPerDay são limites de envio próprios de cada número do projeto, definidos pela plataforma; null usa os limites padrão do gateway.

Guia: Projetos e conexões

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