Skip to content

Uma execução, com os passos

GET/api/workflows/runs/{runId}

Auth
Requires a token
API key:
workflows:read
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner, admin, moderador e financeiro. Cada passo: nó, resultado (`DONE`, `WAITING`, `SKIPPED`), motivo (`optedOut`, `suppressed`, `reputationPaused`, `workflowFrequencyLimit`, `emailUnavailable`, `noEmailAddress`) e, no e-mail, o assunto e o idioma enviados (o HTML não é guardado). No passo "Registrar log", `data.message` só vem para owner e admin (como em `GET /api/logs?type=workflows`); moderador e financeiro recebem só `data.level`. Desde 2026-10-26 (histórico de execuções): `triggerNodeId` e `triggerData` (as variáveis do gatilho como foram guardadas, só as configuradas no webhook); `workflowVersionId` e `version` (`{ id, number, graph, layout }`, o desenho da versão em que a execução rodou, para nomes e regras); e, por passo, `startedAt`, `finishedAt` e `snapshot` do que o passo viu e fez na hora: numa condição, `rules[]` com `kind`, `expected` (a regra), `actual` (o valor comparado: tags, campo, último acesso, variável simples, os grupos da pessoa entre os da regra, `{ allowed, reason }` do espaço, a data da visita, `{ status, registeredAt }` ou `{ attended, checkedInAt }` do evento, `{ status, enrolledAt, completedAt }` do curso, `{ status, at }` da compra ou do carrinho; lista vazia é `[]` e registro que não existe é `null`; o de compra e carrinho só para owner, admin e financeiro, os demais recebem `hidden: true`; variável restrita, como `dm.text`, nunca) e `holds`; numa DM, comentário ou Slack, `output.text` como saiu; num e-mail, `output` com `messageId`, `deliveryStatus` e `recipient` mascarado (m***@dominio). Passos de antes não têm esses campos (`null`). Nunca traz segredo, nota privada, conteúdo de RH nem o corpo do webhook além das variáveis configuradas.

Parameters

NameInTypeDescription
runIdrequiredpathstring (uuid)

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

StatusDescription
200A execução.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
500Erro interno do servidor.

curl example

curl -X GET "https://api.memberfy.net/api/workflows/runs/<runId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"