# Latest version
curl --request GET \
--url https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID} \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a specific version number
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?workflowVersionNumber=3' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a specific version UUID
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?workflowVersionId={WORKFLOW_VERSION_ID}' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a semantic version
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?version=2.1' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
url = "https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}
# Latest version
response = requests.get(url, headers=headers)
# Or pin to a specific version
# response = requests.get(url, headers=headers, params={"workflowVersionNumber": 3})
# response = requests.get(url, headers=headers, params={"workflowVersionId": "{WORKFLOW_VERSION_ID}"})
# response = requests.get(url, headers=headers, params={"version": "2.1"})
print(response.json())
// Latest version
const response = await fetch(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}",
{
method: "GET",
headers: {
"x-service-key": "{YOUR_SERVICE_KEY}",
},
}
);
// Or pin to a specific version
// const url = new URL("https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}");
// url.searchParams.set("workflowVersionNumber", "3");
// const response = await fetch(url, { headers: { "x-service-key": "{YOUR_SERVICE_KEY}" } });
const data = await response.json();
console.log(data);
{
"workflowId": "{WORKFLOW_ID}",
"workflowVersionId": "{WORKFLOW_VERSION_ID}",
"workflowVersionNumber": 3,
"latestVersionNumber": 3,
"name": "Quarterly Report Processor",
"description": "Summarizes quarterly financial reports",
"validityStatus": "valid",
"activeStatus": "active",
"workflowInputNodeId": "{INPUT_NODE_ID}",
"workflowOutputNodeId": "{OUTPUT_NODE_ID}",
"startingNodeIds": ["{INPUT_NODE_ID}"],
"endingNodeIds": ["{OUTPUT_NODE_ID}"],
"nodes": {
"{INPUT_NODE_ID}": {
"id": "{INPUT_NODE_ID}",
"name": "Workflow Input",
"input_schema": {
"schema": {
"{VARIABLE_NAME_1}": {
"display_name": "{DISPLAY_NAME}",
"allowed_types": [{ "type": "str", "type_definition": null }]
}
}
}
}
},
"edges": {
"{EDGE_ID}": {
"from_node_id": "{INPUT_NODE_ID}",
"to_node_id": "{OUTPUT_NODE_ID}"
}
},
"sections": {},
"notes": {},
"designStage": "build",
"designOwner": null,
"lastRun": "2026-08-01T14:32:11Z"
}
Workflows
Get Workflow Details
Retrieve the workflow object — name, status, nodes and edges
GET
/
api
/
v1
/
workflow
/
{workflowId}
# Latest version
curl --request GET \
--url https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID} \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a specific version number
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?workflowVersionNumber=3' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a specific version UUID
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?workflowVersionId={WORKFLOW_VERSION_ID}' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a semantic version
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?version=2.1' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
url = "https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}
# Latest version
response = requests.get(url, headers=headers)
# Or pin to a specific version
# response = requests.get(url, headers=headers, params={"workflowVersionNumber": 3})
# response = requests.get(url, headers=headers, params={"workflowVersionId": "{WORKFLOW_VERSION_ID}"})
# response = requests.get(url, headers=headers, params={"version": "2.1"})
print(response.json())
// Latest version
const response = await fetch(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}",
{
method: "GET",
headers: {
"x-service-key": "{YOUR_SERVICE_KEY}",
},
}
);
// Or pin to a specific version
// const url = new URL("https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}");
// url.searchParams.set("workflowVersionNumber", "3");
// const response = await fetch(url, { headers: { "x-service-key": "{YOUR_SERVICE_KEY}" } });
const data = await response.json();
console.log(data);
{
"workflowId": "{WORKFLOW_ID}",
"workflowVersionId": "{WORKFLOW_VERSION_ID}",
"workflowVersionNumber": 3,
"latestVersionNumber": 3,
"name": "Quarterly Report Processor",
"description": "Summarizes quarterly financial reports",
"validityStatus": "valid",
"activeStatus": "active",
"workflowInputNodeId": "{INPUT_NODE_ID}",
"workflowOutputNodeId": "{OUTPUT_NODE_ID}",
"startingNodeIds": ["{INPUT_NODE_ID}"],
"endingNodeIds": ["{OUTPUT_NODE_ID}"],
"nodes": {
"{INPUT_NODE_ID}": {
"id": "{INPUT_NODE_ID}",
"name": "Workflow Input",
"input_schema": {
"schema": {
"{VARIABLE_NAME_1}": {
"display_name": "{DISPLAY_NAME}",
"allowed_types": [{ "type": "str", "type_definition": null }]
}
}
}
}
},
"edges": {
"{EDGE_ID}": {
"from_node_id": "{INPUT_NODE_ID}",
"to_node_id": "{OUTPUT_NODE_ID}"
}
},
"sections": {},
"notes": {},
"designStage": "build",
"designOwner": null,
"lastRun": "2026-08-01T14:32:11Z"
}
Before you can execute a case, you must know what inputs the workflow expects. This endpoint returns the workflow object: its name, status, and the full node/edge graph.
The workflow’s input definitions live on the input node: look up
nodes[workflowInputNodeId].input_schema.schema to get the variable names and types you need for the Execute Case payload.
By default, the response describes the latest version of the workflow. To inspect a specific historical version, pass one of the three version selectors as a query parameter.
When more than one selector is supplied, they resolve in this order of priority:
workflowVersionId— the version UUIDversion— the semantic version,<MAJOR>.<MINOR>workflowVersionNumber— the sequential version number
Path Parameters
Query Parameters
Specific workflow version UUID. Highest priority — takes precedence over
version and workflowVersionNumber when more than one is supplied.Semantic workflow version as
<MAJOR>.<MINOR>, for example 2.1. A leading v is accepted and stripped (v2.1 is the same as 2.1).Both components must be integers, and the value is sent as a string — 1.10 and 1.1 are different versions.Sequential workflow version number to retrieve. Lowest priority. Omit all three selectors to use the latest version.
Headers
Response
ID of the workflow input node — its entry in
nodes carries the input schema for Execute CaseID of the workflow output node — its entry in
nodes defines the output variables returned by Get Case ResultsThe workflow nodes keyed by node ID. Node objects use snake_case keys — the input node’s
input_schema.schema maps variable names to their definitions (type, display_name, type_definition, …).The organisational layer: named boxes grouping steps, each with an owner, duration estimate and review status. Keyed by section ID.Open object — the workflow model owns this shape and new fields appear without an API version bump, so read defensively.
Design lifecycle stage. One of
interview, generating, rewire, or build.Workflows created before the design flow, and all non-Discovery creations, read as build.The Discovery approver who owns the design flow, as
{id, name, imgSrc}. null outside the design flow.Errors
version is not in <MAJOR>.<MINOR> (or v<MAJOR>.<MINOR>) form, or a selector is otherwise malformed.Supported Data Types
Variables innodes[*].input_schema and nodes[*].output_schema use the Opus type system. For the full list of types, nested type_definition shapes and date formats, see Variable Schemas.
# Latest version
curl --request GET \
--url https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID} \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a specific version number
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?workflowVersionNumber=3' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a specific version UUID
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?workflowVersionId={WORKFLOW_VERSION_ID}' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
# Pinned to a semantic version
curl --request GET \
--url 'https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}?version=2.1' \
--header 'x-service-key: {YOUR_SERVICE_KEY}'
import requests
url = "https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}
# Latest version
response = requests.get(url, headers=headers)
# Or pin to a specific version
# response = requests.get(url, headers=headers, params={"workflowVersionNumber": 3})
# response = requests.get(url, headers=headers, params={"workflowVersionId": "{WORKFLOW_VERSION_ID}"})
# response = requests.get(url, headers=headers, params={"version": "2.1"})
print(response.json())
// Latest version
const response = await fetch(
"https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}",
{
method: "GET",
headers: {
"x-service-key": "{YOUR_SERVICE_KEY}",
},
}
);
// Or pin to a specific version
// const url = new URL("https://operator.opus.com/api/v1/workflow/{YOUR_WORKFLOW_ID}");
// url.searchParams.set("workflowVersionNumber", "3");
// const response = await fetch(url, { headers: { "x-service-key": "{YOUR_SERVICE_KEY}" } });
const data = await response.json();
console.log(data);
{
"workflowId": "{WORKFLOW_ID}",
"workflowVersionId": "{WORKFLOW_VERSION_ID}",
"workflowVersionNumber": 3,
"latestVersionNumber": 3,
"name": "Quarterly Report Processor",
"description": "Summarizes quarterly financial reports",
"validityStatus": "valid",
"activeStatus": "active",
"workflowInputNodeId": "{INPUT_NODE_ID}",
"workflowOutputNodeId": "{OUTPUT_NODE_ID}",
"startingNodeIds": ["{INPUT_NODE_ID}"],
"endingNodeIds": ["{OUTPUT_NODE_ID}"],
"nodes": {
"{INPUT_NODE_ID}": {
"id": "{INPUT_NODE_ID}",
"name": "Workflow Input",
"input_schema": {
"schema": {
"{VARIABLE_NAME_1}": {
"display_name": "{DISPLAY_NAME}",
"allowed_types": [{ "type": "str", "type_definition": null }]
}
}
}
}
},
"edges": {
"{EDGE_ID}": {
"from_node_id": "{INPUT_NODE_ID}",
"to_node_id": "{OUTPUT_NODE_ID}"
}
},
"sections": {},
"notes": {},
"designStage": "build",
"designOwner": null,
"lastRun": "2026-08-01T14:32:11Z"
}
Was this page helpful?