contacts.flows

Automações do contato. Execuções de automação (flows) deste contato, mais recentes primeiro (até 200). status: active (rodando), waiting (esperando resposta ou prazo), completed, failed, cancelled (cancelada ou expirada). lastStepAt = último passo executado; error = último erro da execução.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "contactId": {
      "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)$"
    }
  },
  "required": [
    "contactId"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs contacts.flows --json '{"contactId":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta contacts_flows 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": {
          "runId": {
            "type": "string"
          },
          "flowId": {
            "type": "string"
          },
          "flowName": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "waiting",
              "completed",
              "failed",
              "cancelled",
              "suppressed"
            ]
          },
          "startedAt": {
            "type": "string"
          },
          "lastStepAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "error": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "runId",
          "flowId",
          "flowName",
          "status",
          "startedAt",
          "lastStepAt",
          "error"
        ],
        "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).