Skip to main content
GET
Get a workflow run

Authorizations

Authorization
string
header
required

A Modus personal access token (modus_<orgUuid>_<prefix>_<secret>) or an OAuth 2.1 access token, sent as Authorization: Bearer <token>.

Path Parameters

id
number
required

Numeric workflow id.

Example:

42

runId
string
required

Run identifier.

Example:

"wf_42_run_1"

Query Parameters

temporalRunId
string

Response

id
string
required

Composite run identifier (workflowId:temporalRunId).

Example:

"wf_42_run_1:11111111-2222-3333-4444-555555555555"

workflowId
string
required

Workflow run identifier.

Example:

"wf_42_run_1"

agentId
number
required

Parent workflow id.

Example:

42

agentName
string
required

Snapshot of the workflow name at the time the run was indexed.

Example:

"Daily Sales Report"

agentType
enum<string>
required

Workflow type.

Available options:
task,
workflow
Example:

"task"

status
string
required

Run status (running / awaiting_human / completed / error / cancelled).

Example:

"completed"

source
enum<string>
required

Where the payload was read from. live-query = the run is still in progress; history = a completed run.

Available options:
live-query,
history
temporalRunId
string

Run identifier; a workflow may have multiple runs after a retry.

triggerType
string

Trigger type for the run (schedule / webhook / api / slack / manual).

startedAt
string

ISO-8601 start timestamp.

endedAt
string

ISO-8601 end timestamp; absent for in-flight runs.

durationMs
number

Duration in milliseconds (when end timestamp is known).

summary
string

Short human-readable summary of the run outcome.

pendingApproval
object

Pending approval payload (only present when status is awaiting_human).

statusReason
enum<string>

Display-only signal that the workflow closed for a non-success reason.

Available options:
approval_timeout
taskResult
object

Final result of a task-typed workflow run. Free-form (depends on the workflow).

taskError
string

Error message for a failed task-typed workflow run.

workflowNodes
object[]

Per-node state for a workflow-typed workflow run.

historyUnavailableReason
string

Set when history was unavailable; source will be live-query in that case.