Skip to content

Workflows da comunidade

GET/api/workflows

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 (estes dois só leem); membro: 403. Filtro `status`. `since=7d|30d` conta em `runs` só as execuções iniciadas no período (as em andamento sempre contam). Fase 5: `runs.failed` (terminaram em erro), `runs.skipped` (eventos que chegaram com a pessoa no meio de uma execução, `alreadyRunning`) e `runs.lastRunAt`; `canStop` em cada item; `activeCount` (ligados) e `maxActive` (o teto do plano, `workflows.maxActive`; null = sem limite) ao lado de `data`.

Parameters

NameInTypeDescription
statusoptionalqueryDRAFT | ACTIVE | PAUSED
sinceoptionalquery7d | 30d

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
200Os workflows (sem o desenho), cada um com `canEdit`, `canActivate`, `canDelete` e `canStop`; `permissions.canCreate` diz se a pessoa pode criar.
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.
500Erro interno do servidor.

curl example

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