List workflow runs
curl --request GET \
--url https://api.example.com/v1/workflows/{workflow_id}/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/workflows/{workflow_id}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/workflows/{workflow_id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workflows/{workflow_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workflows/{workflow_id}/runs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/workflows/{workflow_id}/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"runs": [
{
"id": "<string>",
"workflowId": "<string>",
"workflowVersionId": "<string>",
"triggerId": "<string>",
"triggerType": "<string>",
"status": "<string>",
"params": {},
"errorReason": "<string>",
"steps": [
{
"id": "<string>",
"stepId": "<string>",
"type": "<string>",
"status": "<string>",
"detail": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nodes": [
{
"id": "<string>",
"nodeKey": "<string>",
"nodeType": "<string>",
"sequence": 123,
"status": "<string>",
"outcome": "<string>",
"attempt": 123,
"errorReason": "<string>",
"skipReason": "<string>",
"decidedByNodeKey": "<string>",
"result": {},
"startedAt": "<string>",
"completedAt": "<string>"
}
],
"businessOutcome": "<string>",
"createdAt": "<string>",
"dispatchedAt": "<string>",
"completedAt": "<string>"
}
],
"nextPageToken": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Workflows
List workflow runs
List a workflow’s runs, newest first, each with its per-step or per-node detail so you can see where a run stopped and what it produced.
GET
/
v1
/
workflows
/
{workflow_id}
/
runs
List workflow runs
curl --request GET \
--url https://api.example.com/v1/workflows/{workflow_id}/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/v1/workflows/{workflow_id}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/v1/workflows/{workflow_id}/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/workflows/{workflow_id}/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/workflows/{workflow_id}/runs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/workflows/{workflow_id}/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/workflows/{workflow_id}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"runs": [
{
"id": "<string>",
"workflowId": "<string>",
"workflowVersionId": "<string>",
"triggerId": "<string>",
"triggerType": "<string>",
"status": "<string>",
"params": {},
"errorReason": "<string>",
"steps": [
{
"id": "<string>",
"stepId": "<string>",
"type": "<string>",
"status": "<string>",
"detail": {},
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"nodes": [
{
"id": "<string>",
"nodeKey": "<string>",
"nodeType": "<string>",
"sequence": 123,
"status": "<string>",
"outcome": "<string>",
"attempt": 123,
"errorReason": "<string>",
"skipReason": "<string>",
"decidedByNodeKey": "<string>",
"result": {},
"startedAt": "<string>",
"completedAt": "<string>"
}
],
"businessOutcome": "<string>",
"createdAt": "<string>",
"dispatchedAt": "<string>",
"completedAt": "<string>"
}
],
"nextPageToken": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"code": "<string>",
"request_id": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Query Parameters
Token from a previous page's next_page_token.
Runs per page, 1 to 100.
Required range:
1 <= x <= 100Response
Successful Response
Show child attributes
Show child attributes