Docs

Get Run

Check one run: status, timing, task count, and, while it is still running, the step it is on.

GET

Path

Path parameters
stringrequired

The run's id, from List Runs.

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

idstring

Unique id of the run.

workflowIdstring

The workflow this run belongs to.

statusstring

Where the run stands or how it ended: waiting, running, finished, failed, cancelled, interrupted, limitExceeded, or cancelling.

versionstring

The workflow version that ran, or "draft".

environmentIdstring

The environment the run targeted.

environmentNamestring

That environment's name.

startedOndate

When the run started.

finishedOndate

When the run finished. Empty while it is still going.

durationMsnumber

How long the run took, in milliseconds.

operationsnumber

How many tasks the run used. This is the number that counts against your limit.

errorCountnumber

How many errors the run logged.

warningCountnumber

How many warnings the run logged.

infoCountnumber

How many info entries the run logged.

endUserIdstring

The embedded end user the run belongs to, if any.

installationIdstring

The embedded installation the run belongs to, if any.

triggerAppSlugstring

The app that triggered the run.

summarystring

A short summary of what the run did.

activeStepIdstring

The step the run is on right now, while running.

activeMessagestring

What the run is doing right now, while running.