Axuz Developers

GET /api/teams/{teamId}/mail/api-keys/

Lista chaves do team (ativas + revogadas)

  • Acesso: Admin da equipe
  • Serviço: https://mail-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— GET /api/teams/:teamId/mail/api-keys. Lista TODAS as chaves do team (ativas e revogadas), ordenadas por criação decrescente. Chamado pela UI de admin do team. Não paginado (volume baixo — chaves por team em ordem de unidades).

Parâmetros

NomeEmTipoObrigatórioDescrição
teamIdpathstringsim

Respostas

200

Coleção ordenada por created_at DESC

NomeTipoObrigatórioDescrição
itemsarray<MailApiKeyListItem>não
items[].idstring<uuid>sim
items[].namestringsim
items[].key_prefixstringsim

8 primeiros chars do plaintext (para display).

items[].scopesarray<string>sim
items[].rate_limit_per_minintegersim
items[].allowed_from_addressesarray<string<email>>não
items[].enabledbooleansim
items[].last_used_atstring<date-time> | nullnão
items[].created_atstring<date-time>sim
items[].revoked_atstring<date-time> | nullnão

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é owner/admin do team

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/", {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())