Ver .md

notifications.list

Listar minhas notificações. Notificações do próprio usuário na conta atual, mais novas primeiro. filter: all, unread, activity (atribuições), system (números com falha ou desconectados), mention (menções a você). limit até 50; nextCursor continua a lista.

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

Entrada

CampoTipoObrigatórioNota
filter"all" | "unread" | "activity" | "system" | "mention"nãopadrão "all"
limitintegernãopadrão 30
cursorstringnão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filter": {
      "default": "all",
      "type": "string",
      "enum": [
        "all",
        "unread",
        "activity",
        "system",
        "mention"
      ]
    },
    "limit": {
      "default": 30,
      "type": "integer",
      "minimum": 1,
      "maximum": 50
    },
    "cursor": {
      "type": "string",
      "maxLength": 200
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs notifications.list --json '{"filter":"unread","limit":30}'

MCP: ferramenta notifications_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"
          },
          "kind": {
            "type": "string"
          },
          "category": {
            "type": "string",
            "enum": [
              "activity",
              "system",
              "mention"
            ]
          },
          "title": {
            "type": "string"
          },
          "body": {
            "type": [
              "string",
              "null"
            ]
          },
          "actionUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "readAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "tone": {
            "type": "string",
            "enum": [
              "danger",
              "success",
              "info"
            ]
          },
          "channelType": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "whatsapp",
                  "whatsapp_qr",
                  "instagram",
                  "telegram",
                  "webchat",
                  "email",
                  "sms",
                  "voice"
                ]
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "id",
          "kind",
          "category",
          "title",
          "body",
          "actionUrl",
          "readAt",
          "createdAt",
          "tone",
          "channelType"
        ],
        "additionalProperties": false
      }
    },
    "nextCursor": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "items",
    "nextCursor"
  ],
  "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).