---
title: "Get Workflow"
method: GET
path: "/wf/{workflow_id}/"
tags: ["workflows"]
---

# Get Workflow

`GET /wf/{workflow_id}/`

Get a workflow by ID

## Path parameters

- `workflow_id` string, required

## Response `200`

Successful Response

- WorkflowResponseSchema — A response containing the details of a workflow.
  - `id` string, required
  - `name` string, required
  - `description` string, nullable, required
  - `definition` WorkflowDefinitionSchemaOutput, required — A workflow is a DAG of nodes.
    - `nodes` WorkflowNodeSchemaOutput[], required
      - `id` string, required
      - `title` string
      - `parent_id` string, nullable
      - `node_type` string, required
      - `config` object
      - `coordinates` WorkflowNodeCoordinatesSchema — Coordinates for a node in a workflow.
        - `x` number, required
        - `y` number, required
      - `dimensions` WorkflowNodeDimensionsSchema — Dimensions for a node in a workflow.
        - `width` number, required
        - `height` number, required
      - `subworkflow` WorkflowDefinitionSchemaOutput — recursive
    - `links` WorkflowLinkSchema[], required
      - `source_id` string, required
      - `target_id` string, required
      - `source_handle` string, nullable
      - `target_handle` string, nullable
    - `test_inputs` object[]
    - `spur_type` 'workflow' | 'chatbot' | 'agent' — Enum representing the type of spur. Workflow: Standard workflow with nodes and edges Chatbot: Essentially a workflow with chat compatible IO and session management Agent: Autonomous agent node that calls tools, also has chat compatible IO and session management
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error

## Changes

- **2025-03-12** `181efcea9e6e` — 1 info
  - endpoint added
- **2024-11-23** `a2d864f3a8db` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/pyspur-dev/apis/pyspur-api/changes/wf/:workflow_id/get.md)

---

[API](https://skmtc.dev/pyspur-dev/apis/pyspur-api.md) · [All operations](https://skmtc.dev/pyspur-dev/apis/pyspur-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/pyspur-dev/pyspur-api/revisions/adc77484c851/schema)