Runs

Get Run

Returns the latest status of a Run and output when complete.

get/v1/runs/{flowRunId}

Path parameters

flowRunIdstring required

Example:fb701ac1-1246-4860-b1ec-bd916b97a990

The Sohar ID for the Run

Response

A Run

flowRunIdstring required

The Sohar ID for the Run.

status'CREATED' | 'IN_PROGRESS' | 'PENDING' | 'COMPLETE' | 'ERROR' required

Current status of the Run.

outputobject nullable required

The Run output when status is COMPLETE. The schema of this object is defined in the Flow template.

Example response

{
  "flowRunId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "errors": [
    {
      "status": 400,
      "param": "payerId",
      "error": "invalid_request_error",
      "state": "create-verification"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.