Skip to main content
GET
/
workflows
/
{id}
Get Workflow
curl --request GET \
  --url https://app.splox.io/api/v1/workflows/{id} \
  --header 'Authorization: Bearer <token>'
{
  "workflow": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "latest_version": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_number": 123,
      "name": "<string>",
      "status": "draft",
      "description": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "is_public": true
  },
  "workflow_version": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "name": "<string>",
    "status": "draft",
    "description": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "nodes": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "node_type": "start",
      "label": "<string>",
      "pos_x": 123,
      "pos_y": 123,
      "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "extent": "<string>",
      "data": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "edges": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "target": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "edge_type": "condition",
      "source_handle": "<string>",
      "data": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}
Retrieves a workflow with its draft version, all nodes, and all edges. This gives you the complete workflow structure.

​
Usage

curl https://app.splox.io/api/v1/workflows/019c3221-29d7-70e1-aa1e-dee02589289b \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Path Parameters

ParameterTypeDescription
idstring (uuid)Workflow ID

​
Response

{
  "workflow": {
    "id": "019c3221-29d7-70e1-aa1e-dee02589289b",
    "user_id": "0199d001-c45d-9e0f-3456-789012cdef01",
    "latest_version": {
      "id": "019c3221-29da-7d08-93fa-c48dbaa8b1db",
      "workflow_id": "019c3221-29d7-70e1-aa1e-dee02589289b",
      "version_number": 1,
      "name": "My Workflow",
      "status": "draft",
      "created_at": "2025-10-22T10:00:00Z",
      "updated_at": "2025-10-22T10:00:00Z"
    },
    "created_at": "2025-10-22T10:00:00Z",
    "updated_at": "2025-10-22T10:00:00Z"
  },
  "workflow_version": {
    "id": "019c3221-29da-7d08-93fa-c48dbaa8b1db",
    "workflow_id": "019c3221-29d7-70e1-aa1e-dee02589289b",
    "version_number": 1,
    "name": "My Workflow",
    "status": "draft",
    "created_at": "2025-10-22T10:00:00Z",
    "updated_at": "2025-10-22T10:00:00Z"
  },
  "nodes": [
    {
      "id": "019c3221-29dc-7735-a4e3-b42ebb1a0cf1",
      "workflow_version_id": "019c3221-29da-7d08-93fa-c48dbaa8b1db",
      "node_type": "start",
      "label": "Basic Agent",
      "pos_x": 100.0,
      "pos_y": 200.0,
      "data": {},
      "created_at": "2025-10-22T10:00:00Z",
      "updated_at": "2025-10-22T10:00:00Z"
    },
    {
      "id": "019c3221-29dc-7735-a4e3-b42ebb1a0cf2",
      "workflow_version_id": "019c3221-29da-7d08-93fa-c48dbaa8b1db",
      "node_type": "agent",
      "label": "Agent",
      "pos_x": 400.0,
      "pos_y": 200.0,
      "data": {},
      "created_at": "2025-10-22T10:00:00Z",
      "updated_at": "2025-10-22T10:00:00Z"
    }
  ],
  "edges": [
    {
      "id": "019c3221-29dd-1234-a4e3-b42ebb1a0cf3",
      "workflow_version_id": "019c3221-29da-7d08-93fa-c48dbaa8b1db",
      "source": "019c3221-29dc-7735-a4e3-b42ebb1a0cf1",
      "target": "019c3221-29dc-7735-a4e3-b42ebb1a0cf2",
      "edge_type": "condition",
      "created_at": "2025-10-22T10:00:00Z",
      "updated_at": "2025-10-22T10:00:00Z"
    }
  ]
}

​
Node Types

TypeDescription
startStart node — entry point for workflow execution
agentAI Agent node — processes input with an LLM
toolTool node — executes an external tool or function
switchSwitch node — conditional branching
mergeMerge node — combines parallel branches
endEnd node — terminates the workflow

​
Edge Types

TypeDescription
conditionConditional edge — follows based on a condition
parallelParallel edge — executes branches concurrently
toolTool edge — connects agent to tool nodes
errorError edge — followed when a node fails

​
Notes

Authentication required: The authenticated user must own the workflow.
The workflow_version at the top level is the draft version (for editing). The latest_version nested inside workflow is the latest by version number and may differ if a version has been published.

Authorizations

​
Authorization
string
header
required

API token generated from your Splox account settings. Create tokens at https://app.splox.io/account?tab=settings

Path Parameters

​
id
string<uuid>
required

Workflow ID

Response

Workflow retrieved successfully

Complete workflow with version, nodes, and edges

​
workflow
object
required

Represents a user's workflow

​
workflow_version
object
required

Represents a specific version of a workflow

​
nodes
object[]
required
​
edges
object[]
required