Get Workflow | Onepin

{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "user_id": "9b2d5f1e-4c3a-4f7a-8a2e-1d2f3b4c5d6e",
    "name": "Monthly Sales Report Workflow",
    "definition": {
      "edges": [
        {
          "from": "node1",
          "to": "node2"
        },
        {
          "from": "node2",
          "to": "node3"
        }
      ],
      "execution_config": {
        "retry_policy": {
          "delay_seconds": 300,
          "max_retries": 3
        },
        "schedule": "0 8 1 * *"
      },
      "nodes": [
        {
          "config": {
            "query": "SELECT * FROM sales WHERE sale_date >= DATE_TRUNC('month', CURRENT_DATE)",
            "source": "sales_database"
          },
          "id": "node1",
          "type": "data_fetch"
        },
        {
          "config": {
            "parameters": {
              "group_by": "region"
            },
            "script": "aggregate_sales.py"
          },
          "id": "node2",
          "type": "data_transform"
        },
        {
          "config": {
            "body_template": "monthly_report_template.html",
            "recipients": [
              "management@company.com"
            ],
            "subject": "Monthly Sales Report"
          },
          "id": "node3",
          "type": "email_send"
        }
      ]
    },
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-04-10T14:45:00Z",
    "description": "Generates and emails the monthly sales report to the management team.",
    "runs_count": 27,
    "last_run_at": "2024-04-01T08:00:00Z",
    "last_run_status": "completed"
  },
  "meta": {
    "request_id": "7f9c2ba4-1d3e-4f6a-9b8c-2a1d3e4f5b6c",
    "timestamp": "2024-04-10T15:00:00Z"
  }
}

Fetch a single workflow by ID.

Returns the full workflow including its definition (graph nodes/edges and execution config), aggregate run stats, and the latest run status. The definition is returned with any backwards-compatible config migrations applied, so node configs always reflect the current schema even if the workflow was saved with an older version.

Use GET /workflows to list multiple workflows without fetching their full definitions.

Fetch a single workflow by ID. Returns the full workflow including its `definition` (graph nodes/edges and execution config), aggregate run stats, and the latest run status. The `definition` is returned with any backwards-compatible config migrations applied, so node configs always reflect the current schema even if the workflow was saved with an older version. Use `GET /workflows` to list multiple workflows without fetching their full definitions.

Authentication

AuthorizationBearer

Clerk JWT token

AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"

Response

Successful Response

dataobject

metaobject

Errors

422

Unprocessable Entity Error

$	curl https://api.onepin.ai/api/v1/workflows/workflow_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

Authentication

Path parameters

Headers

Response

Errors