Ver .md

scheduling.schedule_notifications_list

Listar notificações de uma agenda. Notificações da agenda, da mais antiga à mais nova: quem recebe (recipient: lead ou attendant), quando (direction antes/depois da reunião, offsetMinutes, atTime HH:mm só quando o prazo é em dias), por qual canal (internal só para o atendente; email, sms, whatsapp, tag só para o lead) e o conteúdo. mode é active ou paused. flowId vem vazio: o disparo ainda não está ligado aos flows do Atomiks. Até 5 por agenda. Sem a migration, vem vazio.

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

Entrada

CampoTipoObrigatórioNota
scheduleIdstringsim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "scheduleId": {
      "type": "string",
      "pattern": "^(pessoal:)?[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    }
  },
  "required": [
    "scheduleId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/scheduling.schedule_notifications_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scheduleId":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs scheduling.schedule_notifications_list --json '{"scheduleId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta scheduling_schedule_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"
          },
          "scheduleId": {
            "type": "string"
          },
          "recipeKey": {
            "type": "string"
          },
          "flowId": {
            "type": [
              "string",
              "null"
            ]
          },
          "mode": {
            "type": "string",
            "enum": [
              "active",
              "paused"
            ]
          },
          "active": {
            "type": "boolean"
          },
          "config": {
            "type": "object",
            "propertyNames": {
              "type": "string"
            },
            "additionalProperties": {}
          }
        },
        "required": [
          "id",
          "scheduleId",
          "recipeKey",
          "flowId",
          "mode",
          "active",
          "config"
        ],
        "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).

scheduling.schedule_notifications_list · Atomiks API