List runs of a workflow, newest first
curl --request GET \
--url https://api.pineyard.ai/workflows/{id}/runs \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.pineyard.ai/workflows/{id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pineyard.ai/workflows/{id}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "<string>",
"status": "RUNNING",
"origin": "TRIGGER",
"startedAt": "<string>",
"endedAt": "<string>",
"currentNodeId": "<string>",
"attentionReason": "<string>",
"triggerSummary": "<string>"
}
]{
"error": "invalid_body",
"issues": [
null
]
}{
"error": "not_found"
}Workflows
List runs of a workflow, newest first
Filters combine with AND. The total number of matching runs (ignoring limit/offset) is returned in the X-Total-Count header.
GET
/
workflows
/
{id}
/
runs
List runs of a workflow, newest first
curl --request GET \
--url https://api.pineyard.ai/workflows/{id}/runs \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.pineyard.ai/workflows/{id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.pineyard.ai/workflows/{id}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)[
{
"id": "<string>",
"status": "RUNNING",
"origin": "TRIGGER",
"startedAt": "<string>",
"endedAt": "<string>",
"currentNodeId": "<string>",
"attentionReason": "<string>",
"triggerSummary": "<string>"
}
]{
"error": "invalid_body",
"issues": [
null
]
}{
"error": "not_found"
}Required scope:
workflows.view
Requires workflows enabled for your workspace. Otherwise the request is refused; see Errors.
Authorizations
Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.
Path Parameters
Query Parameters
Available options:
RUNNING, WAITING, NEEDS_ATTENTION, DONE, FAILED, CANCELED 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 TRIGGER = real runs, TEST = test runs.
Available options:
TRIGGER, TEST Exact match on the shopper phone, cart token, order id, order number, or run id.
Maximum string length:
200Required range:
1 <= x <= 200Required range:
x >= 0Response
OK
Available options:
RUNNING, WAITING, NEEDS_ATTENTION, DONE, FAILED, CANCELED Available options:
TRIGGER, TEST 
