cadences.list

Listar cadências de follow-up. Cadências da conta, da mais antiga à mais nova. Cada uma traz os passos planos (steps: position e phase a partir de 1, type call/whatsapp/meeting/task, priority, waitMinutes depois do passo anterior, título e orientação), phaseNames, a etapa que a dispara (stageId/stageName; nulo = avulsa, só aplicada à mão), calendário de atendimento, limite diário por atendente e liveRuns (oportunidades em andamento). Sem a migration, a lista vem vazia.

• Endpoint: POST https://app.atomiks.com.br/api/v1/cadences.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: cadences_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId cadences.list)

Entrada

Sem campos: envie {}.

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

Exemplo

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

CLI:

node cli/atomiks.mjs cadences.list --json '{}'

MCP: ferramenta cadences_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"
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "isActive": {
            "type": "boolean"
          },
          "stageId": {
            "type": [
              "string",
              "null"
            ]
          },
          "stageName": {
            "type": [
              "string",
              "null"
            ]
          },
          "businessHoursCalendarId": {
            "type": [
              "string",
              "null"
            ]
          },
          "dailyLimitPerAttendant": {
            "type": [
              "number",
              "null"
            ]
          },
          "phaseNames": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "steps": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "position": {
                  "type": "number"
                },
                "phase": {
                  "type": "number"
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "call",
                    "whatsapp",
                    "meeting",
                    "task"
                  ]
                },
                "priority": {
                  "type": "string",
                  "enum": [
                    "none",
                    "urgent",
                    "high",
                    "medium",
                    "low"
                  ]
                },
                "waitMinutes": {
                  "type": "number"
                },
                "durationMinutes": {
                  "type": [
                    "number",
                    "null"
                  ]
                },
                "title": {
                  "type": "string"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "position",
                "phase",
                "type",
                "priority",
                "waitMinutes",
                "durationMinutes",
                "title",
                "description"
              ],
              "additionalProperties": false
            }
          },
          "liveRuns": {
            "type": "number"
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "isActive",
          "stageId",
          "stageName",
          "businessHoursCalendarId",
          "dailyLimitPerAttendant",
          "phaseNames",
          "steps",
          "liveRuns",
          "createdAt",
          "updatedAt"
        ],
        "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).