Get a Process

curl --request GET \
  --url https://operator.opus.com/api/v1/discovery/process/{PROCESS_ID} \
  --header 'x-service-key: {YOUR_SERVICE_KEY}'

import requests

process_id = "{PROCESS_ID}"
url = f"https://operator.opus.com/api/v1/discovery/process/{process_id}"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}

response = requests.get(url, headers=headers)
print(response.json())

const processId = "{PROCESS_ID}";

const response = await fetch(
  `https://operator.opus.com/api/v1/discovery/process/${processId}`,
  {
    method: "GET",
    headers: { "x-service-key": "{YOUR_SERVICE_KEY}" },
  }
);

const data = await response.json();
console.log(data);

{
  "id": "{PROCESS_ID}",
  "name": "Invoice Approval",
  "description": "",
  "status": "approved",
  "organizationId": "{ORGANIZATION_ID}",
  "workspaceId": "{WORKSPACE_ID}",
  "stepCount": 8,
  "branchCount": 2,
  "processOrigin": null,
  "parentProcessId": null,
  "steps": [
    {
      "id": "{STEP_ID}",
      "name": "Invoice Request Received",
      "description": "A request or bill arrives from a supplier.",
      "stepOrder": 1,
      "stepType": "task",
      "status": "approved",
      "owner": "Accounts Payable",
      "locked": true,
      "duration": 15,
      "durationUnit": "minutes",
      "durationRange": null,
      "waitingTimeRange": null,
      "branchId": null,
      "branchLabel": null,
      "branchSourceStepId": null,
      "branchRejoinStepId": null,
      "branchOrder": 0,
      "groupId": null,
      "inputs": [{ "id": "{ITEM_ID}", "text": "Supplier invoice" }],
      "outputs": [{ "id": "{ITEM_ID}", "text": "Logged invoice record" }],
      "integrations": [{ "id": "{ITEM_ID}", "text": "Email" }],
      "rules": [],
      "departments": [{ "id": "{ITEM_ID}", "text": "Finance" }],
      "performers": [{ "id": "{ITEM_ID}", "text": "AP Clerk" }],
      "painPoints": [{ "id": "{ITEM_ID}", "text": "Invoices arrive in inconsistent formats" }]
    }
  ],
  "customEdges": [
    {
      "id": "{EDGE_ID}",
      "sourceStepId": "{STEP_ID}",
      "targetStepId": "{STEP_ID}",
      "label": null
    }
  ],
  "processInputs": [],
  "processOutputs": [],
  "processIntegrations": [],
  "processRules": [],
  "milestone": { "country": "United Arab Emirates", "industry": "Financial Services" },
  "createdAt": "2026-08-13T08:00:00.000Z",
  "updatedAt": "2026-08-13T09:12:44.000Z"
}

GET

api

discovery

process

{processId}

curl --request GET \
  --url https://operator.opus.com/api/v1/discovery/process/{PROCESS_ID} \
  --header 'x-service-key: {YOUR_SERVICE_KEY}'

import requests

process_id = "{PROCESS_ID}"
url = f"https://operator.opus.com/api/v1/discovery/process/{process_id}"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}

response = requests.get(url, headers=headers)
print(response.json())

const processId = "{PROCESS_ID}";

const response = await fetch(
  `https://operator.opus.com/api/v1/discovery/process/${processId}`,
  {
    method: "GET",
    headers: { "x-service-key": "{YOUR_SERVICE_KEY}" },
  }
);

const data = await response.json();
console.log(data);

{
  "id": "{PROCESS_ID}",
  "name": "Invoice Approval",
  "description": "",
  "status": "approved",
  "organizationId": "{ORGANIZATION_ID}",
  "workspaceId": "{WORKSPACE_ID}",
  "stepCount": 8,
  "branchCount": 2,
  "processOrigin": null,
  "parentProcessId": null,
  "steps": [
    {
      "id": "{STEP_ID}",
      "name": "Invoice Request Received",
      "description": "A request or bill arrives from a supplier.",
      "stepOrder": 1,
      "stepType": "task",
      "status": "approved",
      "owner": "Accounts Payable",
      "locked": true,
      "duration": 15,
      "durationUnit": "minutes",
      "durationRange": null,
      "waitingTimeRange": null,
      "branchId": null,
      "branchLabel": null,
      "branchSourceStepId": null,
      "branchRejoinStepId": null,
      "branchOrder": 0,
      "groupId": null,
      "inputs": [{ "id": "{ITEM_ID}", "text": "Supplier invoice" }],
      "outputs": [{ "id": "{ITEM_ID}", "text": "Logged invoice record" }],
      "integrations": [{ "id": "{ITEM_ID}", "text": "Email" }],
      "rules": [],
      "departments": [{ "id": "{ITEM_ID}", "text": "Finance" }],
      "performers": [{ "id": "{ITEM_ID}", "text": "AP Clerk" }],
      "painPoints": [{ "id": "{ITEM_ID}", "text": "Invoices arrive in inconsistent formats" }]
    }
  ],
  "customEdges": [
    {
      "id": "{EDGE_ID}",
      "sourceStepId": "{STEP_ID}",
      "targetStepId": "{STEP_ID}",
      "label": null
    }
  ],
  "processInputs": [],
  "processOutputs": [],
  "processIntegrations": [],
  "processRules": [],
  "milestone": { "country": "United Arab Emirates", "industry": "Financial Services" },
  "createdAt": "2026-08-13T08:00:00.000Z",
  "updatedAt": "2026-08-13T09:12:44.000Z"
}

Retrieve a discovered business process — its steps, the edges between them, and the inputs, outputs, systems and rules recorded against each step and against the process as a whole. Requires the Discovery: Read permission in the workspace that owns the process.

Pass processVersionId to read a saved snapshot instead of the current state. Both return the same shape.

Headers

string

required

Your API authentication key

Path Parameters

string

required

The UUID of the process to read.

Query Parameters

string

A saved process version to read instead of the current process. Omit for the latest state.

Response

string

required

The process id.

string

required

Process name.

string

Process description.

string

Process status (e.g., approved).

string

The organization the process belongs to.

string

The workspace the process belongs to.

number

Number of steps in the process.

number

Number of branches in the process.

string | null

Set when the process was started from a business process template.

string | null

Parent process in the discovery hierarchy.

object[]

required

The process steps. See Step object.

object[]

required

Edges connecting the steps. Each has id, sourceStepId, targetStepId and an optional label.

object[]

Process-level inputs. Each entry is { id, text }.

object[]

Process-level outputs. Each entry is { id, text }.

object[]

Systems the process touches, merged across its steps. Each entry is { id, text }.

object[]

Process-level business rules. Each entry is { id, text }.

object | null

Process context: country and industry.

string | null

Creation timestamp (ISO 8601).

string | null

Last update timestamp (ISO 8601).

Step object

Each entry in steps carries the work itself plus everything tagged against it.

string

required

Step id.

string

required

Step name.

string

Step description.

number

Position of the step in the process order.

string

Step type.

string

Step status.

string

Step owner — a user id or a display name.

boolean

Whether the step has been approved (locked).

number | null

Scalar duration, expressed in durationUnit.

string

Unit for the scalar duration.

object | null

Active-duration range as { min, max }, each a { value, unit } bound. Null when the step only has the scalar duration.

object | null

Waiting time after this step, in the same { min, max } shape.

string | null

Branch this step belongs to.

string | null

Label of the branch.

string | null

Step the branch splits from.

string | null

Step the branch rejoins at.

number

Order of this branch among its siblings.

string | null

Group the step belongs to.

object[]

Step inputs. Each entry is { id, text }.

object[]

Step outputs. Each entry is { id, text }.

object[]

Systems the step touches.

object[]

Business rules applied at this step.

object[]

Departments involved.

object[]

People or roles performing the step.

object[]

Pain points recorded on the step.

Errors

Bad Request

processId or processVersionId is not a valid UUID.

Unauthorized

Missing, invalid, or expired API key.

Forbidden

You do not have access to this process — it belongs to another organization, or the key’s user lacks the Discovery: Read permission in its workspace.

Not Found

The process does not exist, or the given version does not belong to it.

curl --request GET \
  --url https://operator.opus.com/api/v1/discovery/process/{PROCESS_ID} \
  --header 'x-service-key: {YOUR_SERVICE_KEY}'

import requests

process_id = "{PROCESS_ID}"
url = f"https://operator.opus.com/api/v1/discovery/process/{process_id}"
headers = {"x-service-key": "{YOUR_SERVICE_KEY}"}

response = requests.get(url, headers=headers)
print(response.json())

const processId = "{PROCESS_ID}";

const response = await fetch(
  `https://operator.opus.com/api/v1/discovery/process/${processId}`,
  {
    method: "GET",
    headers: { "x-service-key": "{YOUR_SERVICE_KEY}" },
  }
);

const data = await response.json();
console.log(data);

{
  "id": "{PROCESS_ID}",
  "name": "Invoice Approval",
  "description": "",
  "status": "approved",
  "organizationId": "{ORGANIZATION_ID}",
  "workspaceId": "{WORKSPACE_ID}",
  "stepCount": 8,
  "branchCount": 2,
  "processOrigin": null,
  "parentProcessId": null,
  "steps": [
    {
      "id": "{STEP_ID}",
      "name": "Invoice Request Received",
      "description": "A request or bill arrives from a supplier.",
      "stepOrder": 1,
      "stepType": "task",
      "status": "approved",
      "owner": "Accounts Payable",
      "locked": true,
      "duration": 15,
      "durationUnit": "minutes",
      "durationRange": null,
      "waitingTimeRange": null,
      "branchId": null,
      "branchLabel": null,
      "branchSourceStepId": null,
      "branchRejoinStepId": null,
      "branchOrder": 0,
      "groupId": null,
      "inputs": [{ "id": "{ITEM_ID}", "text": "Supplier invoice" }],
      "outputs": [{ "id": "{ITEM_ID}", "text": "Logged invoice record" }],
      "integrations": [{ "id": "{ITEM_ID}", "text": "Email" }],
      "rules": [],
      "departments": [{ "id": "{ITEM_ID}", "text": "Finance" }],
      "performers": [{ "id": "{ITEM_ID}", "text": "AP Clerk" }],
      "painPoints": [{ "id": "{ITEM_ID}", "text": "Invoices arrive in inconsistent formats" }]
    }
  ],
  "customEdges": [
    {
      "id": "{EDGE_ID}",
      "sourceStepId": "{STEP_ID}",
      "targetStepId": "{STEP_ID}",
      "label": null
    }
  ],
  "processInputs": [],
  "processOutputs": [],
  "processIntegrations": [],
  "processRules": [],
  "milestone": { "country": "United Arab Emirates", "industry": "Financial Services" },
  "createdAt": "2026-08-13T08:00:00.000Z",
  "updatedAt": "2026-08-13T09:12:44.000Z"
}

Get Started

Workflows

Cases

Files

Business Process Discovery

Integrations

Deprecated

Headers

Path Parameters

Query Parameters

Response

Step object

Errors

​Headers

​Path Parameters

​Query Parameters

​Response

​Step object

​Errors

Headers

Path Parameters

Query Parameters

Response

Step object

Errors