Workflows

Get a workflow run with steps (includes retry columns)

Changed on

Returns the run with its context and every step with its input by default. A step's input is a snapshot of the context when the step started, so in runs with loops (polling, wait, iterations) the response grows with steps × context size. Pass fields=slim to drop run.context and steps[].input; outputs, errors, diagnostics, retry fields and parent stay.

get/api/workflow-runs/{id}

Request

  • Base URL
    http://localhost:3013
  • URL
    http://localhost:3013/api/workflow-runs/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Query parameters

fields'full' | 'slim'

Response

Workflow run details with steps including retry info

OR

Changes

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter fields

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added the optional property / to the response with the status