Get a Run Step

Inspect one step of a run: the exact data it received and the exact data it returned.

GET

Path

Path parameters

stringrequired

The run's id, from List Runs.

stringrequired

The step instance id, from List Run Steps.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Response fields

stepInstanceIdstring

Unique id of this step execution.

stepIdstring

The step in the workflow definition.

actionIdstring

The action the step ran.

successboolean

True if the step succeeded.

ranboolean

True if the step actually executed.

requestobject

The exact data the step received. Its shape depends on the action.

responseobject

The exact data the step returned. Its shape depends on the action and the provider.

Try this request

API Key

Request

curl --request GET \
  --url 'https://connect.mindcloud.co/v2/runs/Rm4pQ7sJt1Ve/steps/Sx4jK9mP2wRd' \
  --header 'Authorization: Bearer $MINDCLOUD_API_TOKEN'

{
  "success": true,
  "data": {
    "stepInstanceId": "string",
    "stepId": "string",
    "actionId": "string",
    "success": true,
    "ran": true,
    "request": {},
    "response": {}
  }
}