# Listar execuções do fluxo

GET /chatbot/flows/{flow_id}/runs

Lista as execuções que começaram neste fluxo nos últimos 7 dias, da mais nova para a mais velha. Vêm sem `steps` e `variables`: para eles, `GET /chatbot/flows/runs/{run_id}`.

## Autenticação

```json
[
  {
    "token": []
  }
]
```

```json
{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}
```

## Parâmetros

```json
[
  {
    "name": "flow_id",
    "in": "path",
    "required": true,
    "schema": {
      "type": "string"
    },
    "description": "ID do fluxo (`id` em `GET /chatbot/flows`)."
  },
  {
    "name": "chat_id",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    },
    "description": "Só desta conversa: o `chat.id` ou só o número com DDI."
  },
  {
    "name": "status",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string",
      "enum": [
        "running",
        "waiting",
        "sleeping",
        "done",
        "limited",
        "paused",
        "expired",
        "error",
        "replied",
        "ai",
        "canceled"
      ]
    },
    "description": "Só as execuções com este status (veja `status` na execução)."
  },
  {
    "name": "limit",
    "in": "query",
    "required": false,
    "schema": {
      "type": "integer",
      "minimum": 1,
      "maximum": 200,
      "default": 50
    },
    "description": "Itens por página (1 a 200; padrão 50)."
  },
  {
    "name": "cursor",
    "in": "query",
    "required": false,
    "schema": {
      "type": "string"
    },
    "description": "O `next_cursor` da página anterior. Sem ele, vem a primeira página."
  }
]
```

## Respostas

```json
{
  "200": {
    "description": "Página da lista.",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "runs"
          ],
          "properties": {
            "runs": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/FlowRun"
              }
            },
            "next_cursor": {
              "type": "string",
              "description": "Cursor da próxima página: mande em `cursor`. Ausente na última página."
            }
          }
        },
        "example": {
          "runs": [
            {
              "id": "rr1b2c3d4e5f6a7",
              "flow_id": "rw1b2c3d4e5f6a7",
              "version": 3,
              "chat_id": "5511999999999@s.whatsapp.net",
              "source": "trigger",
              "status": "waiting",
              "step_count": 2,
              "started_at": "2026-10-17T12:00:00.000Z",
              "updated_at": "2026-10-17T12:00:00.000Z"
            }
          ]
        }
      }
    }
  },
  "400": {
    "description": "`invalid_request`: `limit` fora do permitido ou `cursor` inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "invalid_request",
          "message": "`limit` fora de 1 a 200."
        }
      }
    }
  },
  "401": {
    "description": "Token ausente ou inválido.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "unauthorized",
          "message": "Token inválido."
        }
      }
    }
  },
  "409": {
    "description": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`).",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "inbox_not_paired",
          "message": "A inbox ainda não foi conectada ao WhatsApp. Os dados pertencem ao número conectado; conecte a inbox antes (`inbox_not_paired`)."
        }
      }
    }
  },
  "429": {
    "$ref": "#/components/responses/RateLimited"
  },
  "500": {
    "description": "Falha inesperada ao gravar ou ler os dados.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/OrkesioError"
        },
        "example": {
          "error": "internal_error",
          "message": "Erro interno; tente de novo."
        }
      }
    }
  }
}
```

**Estado:** Disponível

## Compatibilidade de canais

| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim |  |
| WhatsApp (API oficial) | Sim |  |
| Instagram | Sim |  |
| Messenger | Sim |  |
| Telegram | Sim |  |

## Eventos que esta rota gera

Nenhum. Esta rota não gera evento no webhook (nem em `GET /events`): o resultado vem só na resposta.

## Antes e depois (uazapi → Orkesio)

Na uazapi: `GET /chatbot/flows/{id}/runs`.

- Mesmo caminho e mesmas funções; muda o formato: campos em `snake_case`, datas em ISO 8601 (`_at`) e erros em `{error, message}`.
- Caminho com o id nomeado: `/chatbot/flows/{id}/runs` → `/chatbot/flows/{flow_id}/runs`.
- Lista com cursor: `limit` + `cursor` → `{ runs: [...], next_cursor }` (antes `offset` e `items` + `pagination`).
- Campos renomeados (também no filtro da query): `chatid` → `chat_id`, `startedAt` → `started_at`, `stepCount` → `step_count`, `updatedAt` → `updated_at`.

## #/components/schemas/FlowRun

```json
{
  "type": "object",
  "required": [
    "id",
    "flow_id",
    "version",
    "chat_id",
    "source",
    "status",
    "step_count",
    "started_at",
    "updated_at"
  ],
  "description": "Execução do fluxo (o log fica 7 dias). Na lista vem sem `steps` e `variables`.",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID da execução (`run_id`)."
    },
    "flow_id": {
      "type": "string",
      "description": "Fluxo em que a execução começou."
    },
    "version": {
      "type": "integer",
      "description": "Versão publicada em que a execução começou."
    },
    "chat_id": {
      "type": "string",
      "description": "Conversa; vazio se não chegou a ter contato."
    },
    "source": {
      "type": "string",
      "enum": [
        "trigger",
        "start",
        "webhook",
        "schedule"
      ],
      "description": "Como começou. `trigger`: um gatilho; `start`: `POST /chatbot/flows/start`; `webhook`: o webhook público; `schedule`: um agendado (`schedule_flow` ou gatilho de silêncio)."
    },
    "status": {
      "type": "string",
      "enum": [
        "running",
        "waiting",
        "sleeping",
        "done",
        "limited",
        "replied",
        "ai",
        "canceled",
        "paused",
        "expired",
        "error"
      ],
      "description": "`running`: rodando agora; `waiting`: espera a resposta do contato; `sleeping`: no bloco `wait`, esperando o horário de envio ou a inbox reconectar ao WhatsApp (evento `offline`); `done`: terminou; `limited`: parou no anti-loop de um bloco sem `limit_next`; `replied`: o contato respondeu e o fluxo tinha `cancel_on_reply`; `paused`: a conversa foi pausada (à mão, palavra de parada, `chatbot` ou `human`); `ai`: passou a conversa para a IA (bloco `ai`); `expired`: a pergunta ficou sem resposta (24 h, ou o tempo limite sem `timeout_next`); `canceled`: cancelada em `POST /chatbot/flows/runs/cancel`; `error`: parou num erro (veja `error`)."
    },
    "step_count": {
      "type": "integer",
      "description": "Quantos passos o log tem (até 200; passando disso, os mais antigos depois do início saem)."
    },
    "error": {
      "type": "string",
      "description": "Último erro, se houver."
    },
    "started_at": {
      "description": "Começo da execução. ISO 8601 em UTC com milissegundos.",
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "description": "Último passo. ISO 8601 em UTC com milissegundos.",
      "type": "string",
      "format": "date-time"
    },
    "steps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FlowStep"
      },
      "description": "Passos em ordem. Só em `GET /chatbot/flows/runs/{run_id}`."
    },
    "variables": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Variáveis da execução agora. Só em `GET /chatbot/flows/runs/{run_id}`."
    }
  }
}
```

## #/components/schemas/FlowStep

```json
{
  "type": "object",
  "required": [
    "at",
    "event"
  ],
  "description": "Passo da execução. `event`: `start`, `send`, `ask`, `answer`, `request`, `condition`, `set`, `clear`, `contact`, `wait`, `resume`, `schedule`, `goto`, `lead`, `pause`, `unpause`, `human`, `window`, `offline`, `replied`, `timeout`, `ai`, `canceled`, `limit`, `end`, `done`, `paused`, `expired` ou `error`. Textos cortados em 500 caracteres; a resposta da API, em 1000.",
  "properties": {
    "at": {
      "type": "string",
      "format": "date-time",
      "description": "Quando. ISO 8601 em UTC com milissegundos."
    },
    "group_id": {
      "type": "string",
      "description": "Grupo do passo."
    },
    "block_id": {
      "type": "string",
      "description": "Bloco do passo."
    },
    "flow_id": {
      "type": "string",
      "description": "Fluxo do passo, quando é outro (depois de um `go_to_flow`)."
    },
    "target": {
      "type": "string",
      "description": "Fluxo de destino do `schedule` e do `goto`; agente do `ai`; grupo da saída do `timeout`."
    },
    "type": {
      "type": "string",
      "description": "Tipo do bloco (`send`, `ask`…)."
    },
    "event": {
      "type": "string",
      "description": "O que aconteceu no passo (lista na descrição do passo)."
    },
    "text": {
      "type": "string",
      "description": "Mensagem enviada, pergunta, resposta do contato, chamada (`GET host/caminho`, sem a query), regras da condição já com os valores, número do `set_contact` ou o texto que começou o fluxo; segundos do `wait`; quando o `schedule` vai começar; nome do fluxo do `goto`."
    },
    "option": {
      "type": "string",
      "description": "Opção que a resposta escolheu."
    },
    "status": {
      "type": "integer",
      "description": "Status HTTP da chamada."
    },
    "duration_seconds": {
      "type": "number",
      "description": "Duração da chamada, em segundos (com decimais)."
    },
    "ms": {
      "type": "integer",
      "deprecated": true,
      "description": "Obsoleto: a mesma duração em milissegundos. Use `duration_seconds`; sai numa versão próxima."
    },
    "result": {
      "type": "boolean",
      "description": "Resultado da condição."
    },
    "vars": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Variáveis que o passo guardou."
    },
    "response": {
      "type": "string",
      "description": "Corpo que a API devolveu."
    },
    "error": {
      "type": "string",
      "description": "Erro do passo, quando houve."
    }
  }
}
```

## #/components/schemas/OrkesioError

```json
{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
    },
    "message": {
      "type": "string",
      "description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
    },
    "field": {
      "type": "string",
      "description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
    }
  },
  "required": [
    "error",
    "message"
  ],
  "additionalProperties": true,
  "description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
```

## #/components/responses/RateLimited

```json
{
  "description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
  "headers": {
    "Retry-After": {
      "description": "Segundos até poder chamar de novo.",
      "schema": {
        "type": "integer",
        "minimum": 1
      }
    }
  },
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/OrkesioError"
      },
      "example": {
        "error": "rate_limited",
        "message": "Muitas requisições."
      }
    }
  }
}
```

## Guias relacionados

[Visão geral](/docs/overview) · [O que funciona em cada canal](/docs/canais) · [O que muda da uazapi](/docs/o-que-muda)