Get Workflow
curl --request GET \
--url https://app.splox.io/api/v1/workflows/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.splox.io/api/v1/workflows/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.splox.io/api/v1/workflows/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.splox.io/api/v1/workflows/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.splox.io/api/v1/workflows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.splox.io/api/v1/workflows/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.splox.io/api/v1/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
}
]
}Workflows
Get Workflow
Retrieves a workflow with its draft version, all nodes, and all edges.
GET
/
workflows
/
{id}
Get Workflow
curl --request GET \
--url https://app.splox.io/api/v1/workflows/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.splox.io/api/v1/workflows/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.splox.io/api/v1/workflows/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.splox.io/api/v1/workflows/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.splox.io/api/v1/workflows/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.splox.io/api/v1/workflows/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.splox.io/api/v1/workflows/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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"
from splox import SploxClient
client = SploxClient(api_key="YOUR_API_KEY")
wf = client.workflows.get("019c3221-29d7-70e1-aa1e-dee02589289b")
print(wf.workflow.id, wf.workflow_version.name)
print(f"{len(wf.nodes)} nodes, {len(wf.edges)} edges")
import Splox from "splox";
const client = new Splox("YOUR_API_KEY");
const wf = await client.workflows.get("019c3221-29d7-70e1-aa1e-dee02589289b");
console.log(wf.workflow.id, wf.workflow_version.name);
console.log(`${wf.nodes.length} nodes, ${wf.edges.length} edges`);
client := splox.NewClient("YOUR_API_KEY")
wf, err := client.Workflows.Get(ctx, "019c3221-29d7-70e1-aa1e-dee02589289b")
fmt.Println(wf.Workflow.ID, wf.WorkflowVersion.Name)
fmt.Printf("%d nodes, %d edges\n", len(wf.Nodes), len(wf.Edges))
Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string (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
| Type | Description |
|---|---|
start | Entry node — entry point for workflow execution |
agent | AI Agent node — processes input with an LLM |
tool | Tool node — executes an external tool or function |
switch | Switch node — conditional branching |
merge | Merge node — combines parallel branches |
end | End node — terminates the workflow |
Edge Types
| Type | Description |
|---|---|
condition | Conditional edge — follows based on a condition |
parallel | Parallel edge — executes branches concurrently |
tool | Tool edge — connects agent to tool nodes |
error | Error 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
API token generated from your Splox account settings. Create tokens at https://app.splox.io/account?tab=settings
Path Parameters
Workflow ID
Response
Workflow retrieved successfully
Complete workflow with version, nodes, and edges
⌘I

