Skip to main content
GET
Obter um workflow

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticar as requisições à API do Flowker. Provisionada por meio da variável de ambiente API_KEY durante o deployment.

Parâmetros de caminho

id
string<uuid>
obrigatório

Identificador único do workflow.

Resposta

Indica que a solicitação foi bem-sucedida e a resposta contém os dados solicitados.

createdAt
string<date-time>

Marca temporal de quando o workflow foi criado.

Exemplo:

"2026-03-17T14:30:00Z"

description
string

Descrição legível por humanos do workflow.

Exemplo:

"Receives a webhook trigger and logs the payment event."

edges
object[]

Conexões entre nós que definem o fluxo de execução.

id
string<uuid>

Identificador único do workflow.

Exemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

metadata
object

Pares chave-valor personalizados para etiquetar ou categorizar.

Exemplo:
name
string

Nome único do workflow.

Exemplo:

"Payment Notification Flow"

nodes
object[]

Os passos que compõem este workflow.

status
enum<string>

Status atual do ciclo de vida: draft (editável), active (executável) ou inactive (arquivado).

Opções disponíveis:
draft,
active,
inactive
Exemplo:

"active"

updatedAt
string<date-time>

Marca temporal da última atualização.

Exemplo:

"2026-03-17T15:00:00Z"