GET /accounts/{accountId}/folders
Lista folders + contador unread
- Access: Signed in
- Service:
https://mail-api.axuz.net
Accepted authentication
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.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
accountId | path | string | yes |
Responses
200
Coleção
| Name | Type | Required | Description |
|---|---|---|---|
items | array<MailFolder> | no | |
items[].id | string<uuid> | yes | |
items[].account_id | string<uuid> | yes | |
items[].name | string | yes | |
items[].kind | string | yes | enum: |
items[].parent_id | string<uuid> | null | no | |
items[].created_at | string<date-time> | yes | |
items[].unread | integer | yes |
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Não é dono da conta
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
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())