Ver .md

notifications.prefs_get

Ver minhas preferências de notificação. Matriz de Configurações > Notificações: chave geral por canal (general: inApp no app, mobilePush push no celular) e, por categoria, cada tipo de aviso com seu valor em cada canal. Canal null: o aviso não sai por ele (chave inativa). Chave geral desligada: nenhum aviso sai pelo canal. Valem em todas as contas.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/notifications.prefs_get (corpo JSON)
  • Quem pode chamar: qualquer usuário autenticado
  • Escopo da chave: nenhum (qualquer chave serve)
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: notifications_prefs_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId notifications.prefs_get)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

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

CLI:

node cli/atomiks.mjs notifications.prefs_get --json '{}'

MCP: ferramenta notifications_prefs_get com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "general": {
      "type": "object",
      "properties": {
        "inApp": {
          "type": "boolean"
        },
        "mobilePush": {
          "type": "boolean"
        }
      },
      "required": [
        "inApp",
        "mobilePush"
      ],
      "additionalProperties": false
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "kinds": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "inApp": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                },
                "mobilePush": {
                  "type": [
                    "boolean",
                    "null"
                  ]
                }
              },
              "required": [
                "kind",
                "label",
                "description",
                "inApp",
                "mobilePush"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "key",
          "title",
          "kinds"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "general",
    "categories"
  ],
  "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).