AtomiksAPI
Ver .md

inbox.prefs_get

Ver minhas preferências de aviso. Preferências de aviso do próprio usuário: som, escopo (all, mine_free, mine), aviso no app, matriz de avisos (notifyAssigned, notifyDisconnected, notifyTaskAssigned no app; pushNewMessage, pushAssigned, pushDisconnected, pushTaskAssigned no push), chave geral por canal (allInApp, allPush: desligada, nenhum aviso sai por ele) e presença (online). Valem em todas as contas.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/inbox.prefs_get (corpo JSON)
  • Quem pode chamar: qualquer usuário autenticado
  • Escopo da chave: messages:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: inbox_prefs_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId inbox.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/inbox.prefs_get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

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

MCP: ferramenta inbox_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": {
    "sound": {
      "type": "boolean"
    },
    "notifyScope": {
      "type": "string",
      "enum": [
        "all",
        "mine_free",
        "mine"
      ]
    },
    "inApp": {
      "type": "boolean"
    },
    "notifyAssigned": {
      "type": "boolean"
    },
    "notifyDisconnected": {
      "type": "boolean"
    },
    "pushNewMessage": {
      "type": "boolean"
    },
    "pushAssigned": {
      "type": "boolean"
    },
    "pushDisconnected": {
      "type": "boolean"
    },
    "online": {
      "type": "boolean"
    },
    "allInApp": {
      "type": "boolean"
    },
    "allPush": {
      "type": "boolean"
    },
    "notifyTaskAssigned": {
      "type": "boolean"
    },
    "pushTaskAssigned": {
      "type": "boolean"
    }
  },
  "required": [
    "sound",
    "notifyScope",
    "inApp",
    "notifyAssigned",
    "notifyDisconnected",
    "pushNewMessage",
    "pushAssigned",
    "pushDisconnected",
    "online",
    "allInApp",
    "allPush",
    "notifyTaskAssigned",
    "pushTaskAssigned"
  ],
  "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).