Get an entity workflow run

GET/projects/{projectId}/entities/{entityId}/workflows/{workflowId}/runs/{runId}

Base URL: https://api.tinkermode.com

Return the workflow run with the specified ID, including the step execution records accumulated so far.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user API key of a user with read permission on entity workflows (resource type: entityWorkflowRun, action: read), a service account token with the same permission, or a project API key.

Path parameters

Name	Type	Required	Description
`projectId`	integer	Yes	The unique ID for a specified project.
`entityId`	string	Yes	Entity ID (unique within project)
`workflowId`	string	Yes	The unique ID of the workflow (MongoDB ObjectID hex string).
`runId`	string	Yes	The unique ID of the workflow run.

Responses

`200` Successfully retrieved the workflow run.

Content type: application/json

Property Type Required Constraints Description

createdAt string No The time the run was created (ISO 8601).

entityId string No The unique identifier for the entity the workflow belongs to.

error object No Error information set when the run fails. Absent on non-failed runs.

Properties of error
Property	Type	Required	Constraints	Description
`code`	string	No	one of: user, internal, expired	Machine-readable error code. 'user': a failure the user can fix (see 'message'). 'internal': an unexpected failure the user cannot fix. 'expired': the run was not picked up before the timeout.
`message`	string	No		Human-readable, user-facing description of the failure and how to address it. Present for 'user' errors. Safe to display; contains no internal implementation detail.

finishedAt string No The time the run completed (ISO 8601). Absent while the run is queued or running.

id string No The unique identifier for the workflow run.

projectId integer No The unique identifier for the project the run belongs to.

state string No one of: queued, running, succeeded, failed The current lifecycle state of the run.

steps array<object> No The step execution records for this run, in the order the steps were started. Empty on runs that have not executed any step yet.

Properties of steps
Property	Type	Required	Constraints	Description
`branchId`	string	No		The ID of the parent step's branch this step belongs to. Absent for top-level steps.
`finishedAt`	string	No		The time the step completed (ISO 8601). Absent while the step is running.
`id`	string	No		The identifier of the workflow step that was executed.
`inputs`	object	No		The resolved input values the step ran with.
`node`	string	No		The node type the step executed.
`outputs`	object	No		The output values the step produced. Absent unless the step succeeded with output.
`parentId`	string	No		The ID of the step this step branched from. Absent for top-level steps.
`startedAt`	string	No		The time the step started (ISO 8601).
`state`	string	No	one of: running, succeeded, failed, cancelled	The state of the step execution.

trigger object No Contextual information about what triggered this run (e.g. cron schedule, manual).

updatedAt string No The time the run was last updated (ISO 8601).

workflowId string No The unique identifier for the workflow that was executed.

Response example

{
  "createdAt": "2026-07-28T10:15:00.000Z",
  "entityId": "entity123456",
  "finishedAt": "2026-07-28T10:15:01.688Z",
  "id": "6871f2c6a4b39d0f1a2c3d4e::daily-check::1785233700000000000",
  "projectId": 123,
  "state": "succeeded",
  "steps": [
    {
      "finishedAt": "2026-07-28T10:15:01.402Z",
      "id": "read-temperature",
      "inputs": {
        "entityId": "entity123456",
        "metricsDefinitionId": "environment",
        "projectId": 123,
        "query": {
          "aggregation": "avg",
          "begin": "2026-07-28T09:15:00.000Z",
          "end": "2026-07-28T10:15:00.000Z",
          "selectValues": [
            "temperature"
          ]
        }
      },
      "node": "mode.entity.metrics",
      "outputs": {
        "aggregation": "avg",
        "begin": "2026-07-28T09:15:00.000Z",
        "data": {
          "temperature": {
            "displayName": "Temperature",
            "timestamp": "2026-07-28T10:14:32.000Z",
            "unit": "C",
            "value": 31.4
          }
        },
        "end": "2026-07-28T10:15:00.000Z",
        "entityId": "entity123456"
      },
      "startedAt": "2026-07-28T10:15:01.114Z",
      "state": "succeeded"
    },
    {
      "finishedAt": "2026-07-28T10:15:01.688Z",
      "id": "notify-ops",
      "inputs": {
        "message": "Temperature is 31.4 C, above the 28 C threshold.",
        "platform": "slack",
        "target": {
          "channelId": "C024BE91L",
          "workspaceId": "T012AB3CD"
        }
      },
      "node": "mode.assistant.notify",
      "outputs": {
        "message": "Temperature is 31.4 C, above the 28 C threshold.",
        "platform": "slack",
        "target": {
          "channel": "C024BE91L",
          "workspace": "T012AB3CD"
        }
      },
      "startedAt": "2026-07-28T10:15:01.403Z",
      "state": "succeeded"
    }
  ],
  "updatedAt": "2026-07-28T10:15:01.690Z",
  "workflowId": "6871f2c6a4b39d0f1a2c3d4e"
}

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` Workflow run not found.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

Get an entity workflow run

Authentication

Path parameters

Responses

200 Successfully retrieved the workflow run.

Response example

401 Authorization is required to access this resource.

403 Request failed because of denied permission.

404 Workflow run not found.

429 Request failed because of rate limit.

500 An unexpected error has occurred.

503 The service is temporarily unavailable.

`200` Successfully retrieved the workflow run.

`401` Authorization is required to access this resource.

`403` Request failed because of denied permission.

`404` Workflow run not found.

`429` Request failed because of rate limit.

`500` An unexpected error has occurred.

`503` The service is temporarily unavailable.