groups.schedules_list

Listar agendamentos de mensagens da campanha. Agendamentos da campanha (mais recentes primeiro), com as próximas 5 datas (nextRuns, no fuso da campanha) dos que estão scheduled. state: scheduled, paused, done ou canceled.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "state": {
      "type": "string",
      "enum": [
        "scheduled",
        "paused",
        "done",
        "canceled"
      ]
    }
  },
  "required": [
    "campaignId"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.schedules_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-4000-8000-000000000001","state":"scheduled"}'

CLI:

node cli/atomiks.mjs groups.schedules_list --json '{"campaignId":"00000000-0000-4000-8000-000000000001","state":"scheduled"}'

MCP: ferramenta groups_schedules_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"
          },
          "messageId": {
            "type": [
              "string",
              "null"
            ]
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          },
          "kind": {
            "type": "string",
            "enum": [
              "once",
              "recurring"
            ]
          },
          "runAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "weekdays": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "number"
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "timeOfDay": {
            "type": [
              "string",
              "null"
            ]
          },
          "nextRunAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "nextRuns": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "state": {
            "type": "string"
          },
          "target": {},
          "speed": {
            "type": "string"
          },
          "useLatest": {
            "type": "boolean"
          },
          "version": {
            "type": "number"
          },
          "lastRunAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "lastJobIds": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "id",
          "messageId",
          "title",
          "kind",
          "runAt",
          "weekdays",
          "timeOfDay",
          "nextRunAt",
          "nextRuns",
          "state",
          "target",
          "speed",
          "useLatest",
          "version",
          "lastRunAt",
          "lastJobIds"
        ],
        "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).