Get Workflow Details

# 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}'

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}"})

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}"
    }
  },
  "lastRun": "2026-08-01T14:32:11Z"
}

GET

api

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}'

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}"})

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}"
    }
  },
  "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 either the workflowVersionNumber or the workflowVersionId UUID as a query parameter.

Path Parameters

string

required

The unique identifier of the workflow to retrieve details for

Query Parameters

number

Workflow version number to retrieve. Omit to use the latest version.

string

Specific workflow version UUID. Takes precedence over workflowVersionNumber when both are supplied.

Headers

string

required

Your API authentication key

Response

string

required

The workflow ID

string

The workflow version ID this object represents

number

required

The workflow version number this object represents

number

The latest version number of the workflow

string

required

Workflow name

string

Workflow description

string

Validity status of the workflow

string

Active status of the workflow

string

ID of the workflow input node — its entry in nodes carries the input schema for Execute Case

string

ID of the workflow output node — its entry in nodes defines the output variables returned by Get Case Results

string[]

required

IDs of the starting nodes

string[]

required

IDs of the ending nodes

object

required

The 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, …).

object

required

The workflow edges keyed by edge ID

string

ISO timestamp of the workflow’s most recent execution. null if never run.

Errors

Unauthorized

Missing, invalid, or expired API key.

Not Found

The workflow does not exist.

Supported Data Types

Type	Description	Example Value
`str`	Text string	`"Hello World"`
`float`	Numeric value	`45.8`
`bool`	Boolean	`true` or `false`
`date`	Date string	`"2025-11-09"`
`file`	Single file URL	`"https://files.opus.com/..."`
`array`	List of values	`["item1", "item2"]`
`array_files`	Multiple file URLs	`["url1", "url2"]`
`object`	Nested object	`{"key": "value"}`

# 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}'

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}"})

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}"
    }
  },
  "lastRun": "2026-08-01T14:32:11Z"
}

⌘I

Get Started

Workflows

Cases

Files

Deprecated

Get Workflow Details

Path Parameters

Query Parameters

Headers

Response

Errors

Supported Data Types

​Path Parameters

​Query Parameters

​Headers

​Response

​Errors

​Supported Data Types

Path Parameters

Query Parameters

Headers

Response

Errors

Supported Data Types