Skip to main content
GET
List runs of a workflow, newest first
Required scope: workflows.view
Requires workflows enabled for your workspace. Otherwise the request is refused; see Errors.

Authorizations

Authorization
string
header
required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id
string
required

Query Parameters

status
Available options:
RUNNING,
WAITING,
NEEDS_ATTENTION,
DONE,
FAILED,
CANCELED
triggerEvent
enum<string>

Only runs started by this store event.

Available options:
CART_ABANDONED,
ORDER_PLACED,
ORDER_PAID,
ORDER_PARTIALLY_FULFILLED,
ORDER_SHIPPED,
ORDER_OUT_FOR_DELIVERY,
ORDER_DELIVERED,
ORDER_CANCELLED,
ORDER_REFUNDED
origin
enum<string>

TRIGGER = real runs, TEST = test runs.

Available options:
TRIGGER,
TEST
q
string

Exact match on the shopper phone, cart token, order id, order number, or run id.

Maximum string length: 200
limit
integer
Required range: 1 <= x <= 200
offset
integer | null
Required range: x >= 0

Response

OK

id
string
required
status
enum<string>
required
Available options:
RUNNING,
WAITING,
NEEDS_ATTENTION,
DONE,
FAILED,
CANCELED
origin
enum<string>
required
Available options:
TRIGGER,
TEST
startedAt
string
required
endedAt
string | null
required
currentNodeId
string | null
required
attentionReason
string | null
required
triggerSummary
string | null
required