Axuz Developers

GET /accounts/{accountId}/folders

Lista folders + contador unread

  • Acesso: Login
  • 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`.

Ordem semântica: inbox → sent → drafts → archive → spam → trash → custom (alfa). Contador unread é COUNT(*) filtrado por read=false computado on-the-fly.

Parâmetros

NomeEmTipoObrigatórioDescrição
accountIdpathstringsim

Respostas

200

Coleção

NomeTipoObrigatórioDescrição
itemsarray<MailFolder>não
items[].idstring<uuid>sim
items[].account_idstring<uuid>sim
items[].namestringsim
items[].kindstringsim

enum: "inbox", "sent", "drafts", "archive", "spam", "trash", "custom"

items[].parent_idstring<uuid> | nullnão
items[].created_atstring<date-time>sim
items[].unreadintegersim

401

Sem credencial valida

NomeTipoObrigatórioDescrição
errorstringsim

403

Não é dono da conta

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/accounts/ACCOUNT_ID/folders' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://mail-api.axuz.net/accounts/ACCOUNT_ID/folders", {
  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/accounts/ACCOUNT_ID/folders",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())