Workflows API
Get Workflow Runs
Retrieve a list of runs for a specific workflow.
GET
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
/
runs
Path Parameters
app_id
string
requiredThe ID of the app
workflow_id
string
requiredThe ID of the workflow
Query Parameters
verbose
enum<string>[]
Available options:
all
origin
enum<string>
Available options:
ALL
, WORKFLOW
, RECORD
, TEST
status
enum<string>
Available options:
ALL
, PENDING
, RUNNING
, CANCELLED
, COMPLETED
, SKIPPED
, FAILED
page
number
Page number
take
number
Number of items to take
Response
200 - application/json
id
string
requiredUnique identifier for the run
result
any | null
Result of the run
input
object | null
requiredInput values used for the run
output
object | null
requiredOutput of the run
status
enum<string>
requiredStatus of the run
Available options:
PENDING
, RUNNING
, CANCELLED
, COMPLETED
, SKIPPED
, FAILED
origin
enum<string>
requiredOrigin of the run
Available options:
WORKFLOW
, RECORD
, TEST
error
string
Error message if the run failed
started_at
string | null
requiredTimestamp of when the run started
ended_at
string | null
requiredTimestamp of when the run ended
app_id
string
requiredID of the associated app where the run was triggered from
workflow_app_id
string
requiredID of the associated app where the workflow belongs to
workflow_id
string
requiredID of the associated workflow
workflow_version_draft
object | null
requiredDraft version of the workflow
workflow_version
object | null
requiredDetails of the workflow version used for the run
usage
object
Credits usage of the run
created_at
string | null
requiredTimestamp of when the run was created
updated_at
string | null
requiredTimestamp of when the run was last updated
Was this page helpful?