Saltar al contenido principal
GET
/
v1
/
workflows
/
{id}
Obtener un workflow
curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/workflows/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Payment Notification Flow",
  "description": "Receives a webhook trigger and logs the payment event.",
  "status": "active",
  "nodes": [
    {
      "id": "trigger-1",
      "type": "trigger",
      "name": "Webhook Trigger",
      "position": {
        "x": 0,
        "y": 0
      },
      "data": {
        "triggerId": "webhook"
      }
    },
    {
      "id": "log-event",
      "type": "action",
      "name": "Log Payment Event",
      "position": {
        "x": 200,
        "y": 0
      },
      "data": {
        "action": "log"
      }
    }
  ],
  "edges": [
    {
      "id": "e1",
      "source": "trigger-1",
      "target": "log-event"
    }
  ],
  "metadata": {
    "team": "payments",
    "environment": "sandbox"
  },
  "createdAt": "2026-03-17T14:30:00Z",
  "updatedAt": "2026-03-17T14:31:00Z"
}

Autorizaciones

​
X-API-Key
string
header
requerido

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Parámetros de ruta

​
id
string<uuid>
requerido

Identificador único del workflow.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos solicitados.

​
createdAt
string<date-time>

Marca de tiempo de cuando se creó el workflow.

Ejemplo:

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

​
description
string

Descripción legible por humanos del workflow.

Ejemplo:

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

​
edges
object[]

Conexiones entre nodos que definen el flujo de ejecución.

​
id
string<uuid>

Identificador único del workflow.

Ejemplo:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
metadata
object

Pares clave-valor personalizados para etiquetar o categorizar.

Ejemplo:
{
  "team": "payments",
  "environment": "sandbox"
}
​
name
string

Nombre único del workflow.

Ejemplo:

"Payment Notification Flow"

​
nodes
object[]

Los pasos que componen este workflow.

​
status
enum<string>

Estado actual del ciclo de vida: draft (editable), active (ejecutable) o inactive (archivado).

Opciones disponibles:
draft,
active,
inactive
Ejemplo:

"active"

​
updatedAt
string<date-time>

Marca de tiempo de la última actualización.

Ejemplo:

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