Skip to main content
GET
/
v1
/
flow-runs
/
{flowRunId}
Get Run
curl --request GET \
  --url https://api.soharhealth.com/v1/flow-runs/{flowRunId} \
  --header 'Authorization: Bearer <token>'
{
  "flowRunId": "fb701ac1-1246-4860-b1ec-bd916b97a990",
  "status": "CREATED",
  "output": {},
  "errors": [
    {
      "status": 400,
      "param": "payerId",
      "error": "invalid_request_error",
      "state": "create-verification"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
flowRunId
string
required

The Sohar ID for the Run

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

Response

A Run

​
flowRunId
string
required

The Sohar ID for the Run.

Example:

"fb701ac1-1246-4860-b1ec-bd916b97a990"

​
status
enum<string>
required

Current status of the Run.

Available options:
CREATED,
IN_PROGRESS,
PENDING,
COMPLETE,
ERROR
​
output
object
required

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

​
errors
object[]

An optional array of error objects returned when status is ERROR.