email_inbox.list

Listar caixas de e-mail conectadas. Caixas de e-mail (canal email) da conta, da mais antiga à mais nova, só as que o membro pode usar. Cada item é o "canal" do original: status (pending conexão incompleta, live ativa, archived desconectada), emailAddress, emailLastSuccessAt, emailFailingSince e emailLastErrorCode (quando a leitura está falhando, e por quê). Os arquivados só com includeArchived. Exige o módulo de plano messages.email-inbox (senão forbidden). Sem a migration, a lista vem vazia.

• Endpoint: POST https://app.atomiks.com.br/api/v1/email_inbox.list (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: channels:read
• Grava dados: não
• Pela chave de API: sim
• Ferramenta MCP: email_inbox_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId email_inbox.list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "includeArchived": {
      "default": false,
      "type": "boolean"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/email_inbox.list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"includeArchived":false}'

CLI:

node cli/atomiks.mjs email_inbox.list --json '{"includeArchived":false}'

MCP: ferramenta email_inbox_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "channel": {
            "type": "string",
            "const": "email"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "live",
              "error",
              "archived"
            ]
          },
          "stableKey": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "emailAddress": {
            "type": "string"
          },
          "emailLastSuccessAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "emailFailingSince": {
            "type": [
              "string",
              "null"
            ]
          },
          "emailLastErrorCode": {
            "type": [
              "string",
              "null"
            ]
          },
          "profilePhotoUrl": {
            "type": "null"
          },
          "archivedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "archivedReason": {
            "type": "null"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "channel",
          "status",
          "stableKey",
          "displayName",
          "emailAddress",
          "emailLastSuccessAt",
          "emailFailingSince",
          "emailLastErrorCode",
          "profilePhotoUrl",
          "archivedAt",
          "archivedReason",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).