List Workflow Runs

curl --request GET \
  --url https://api-prod.extend.app/workflow_runs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-prod.extend.app/workflow_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-prod.extend.app/workflow_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-prod.extend.app/workflow_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))

}

require 'uri'
require 'net/http'

url = URI("https://api-prod.extend.app/workflow_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

{
  "success": true,
  "nextPageToken": "abc123",
  "workflowRuns": [
  {
    "id": "workflow_run_1234",
    "status": "PROCESSED",
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedByUser": "user@example.com",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "workflowId": "workflow_1234",
    "workflowName": "My Workflow",    
    "workflowVersionId": "workflow_version_1234",
    "batchId": "batch_1234",
    "rejectionNote": "This workflow run was rejected because it was not valid.",
    "createdAt": "2023-01-01T09:41:00.000Z",
    "updatedAt": "2023-01-10T05:39:24.500Z"
  },
  {
    "id": "workflow_run_1235",
    "status": "FAILED",
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedByUser": "user@example.com",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "workflowId": "workflow_1234",
    "workflowName": "My Workflow",    
    "workflowVersionId": "workflow_version_1234",
    "batchId": "batch_1234",
    "rejectionNote": "This workflow run was rejected because it was not valid.",
    "createdAt": "2023-01-01T09:41:00.000Z",
      "updatedAt": "2023-01-10T05:39:24.500Z"
    }
  ]
}

List Workflow Runs

curl --request GET \
  --url https://api-prod.extend.app/workflow_runs \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-prod.extend.app/workflow_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-prod.extend.app/workflow_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-prod.extend.app/workflow_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))

}

require 'uri'
require 'net/http'

url = URI("https://api-prod.extend.app/workflow_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

{
  "success": true,
  "nextPageToken": "abc123",
  "workflowRuns": [
  {
    "id": "workflow_run_1234",
    "status": "PROCESSED",
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedByUser": "user@example.com",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "workflowId": "workflow_1234",
    "workflowName": "My Workflow",    
    "workflowVersionId": "workflow_version_1234",
    "batchId": "batch_1234",
    "rejectionNote": "This workflow run was rejected because it was not valid.",
    "createdAt": "2023-01-01T09:41:00.000Z",
    "updatedAt": "2023-01-10T05:39:24.500Z"
  },
  {
    "id": "workflow_run_1235",
    "status": "FAILED",
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedByUser": "user@example.com",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "workflowId": "workflow_1234",
    "workflowName": "My Workflow",    
    "workflowVersionId": "workflow_version_1234",
    "batchId": "batch_1234",
    "rejectionNote": "This workflow run was rejected because it was not valid.",
    "createdAt": "2023-01-01T09:41:00.000Z",
      "updatedAt": "2023-01-10T05:39:24.500Z"
    }
  ]
}

This endpoint allows you to fetch the runs of a given workflow. This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent pages. Each workflow run object contains a summary of the run. Full details are available by calling the Get WorkflowRun endpoint.

Query Parameters

string

Filters workflow runs by their status.Possible values include:

PENDING
PROCESSING
NEEDS_REVIEW
REJECTED
PROCESSED
FAILED

string

Filters workflow runs by the workflow ID.

string

Filters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the Batch Run Workflow endpoint.

default:"updatedAt"

Sorts the workflow runs by the given field.Possible values include:

updatedAt
createdAt

default:"desc"

Sorts the workflow runs in ascending or descending order.Possible values include:

asc: sort in ascending order
desc: sort in descending order

The token used to fetch the page of results from a previous request.Note: if parameters other than nextPageToken change in subsequent requests, you are likely to receive incomplete results.

default:"10"

The maximum number of results to return per page.You are not guaranteed to receive this many results per page, but you will not receive more than this.

Max: 1000
Min: 1

Response

boolean

A true or false value indicating whether the request was successful or not.

array

An array of WorkflowRun summary objects.

string

The token used to fetch the next page of results.If there are no more pages, the token will not be present.The general pattern for collecting all results is to keep calling the endpoint with the nextPageToken and the same parameters, until the token is not present, for example:

workflow_runs = []
token = None
while True:
  response = list_workflow_runs(nextPageToken=token)
  workflow_runs.extend(response.workflowRuns)
  token = response.nextPageToken
  if not token:
    break

Error Responses

boolean

Will be false if the request failed.

string

A description of the error that occurred.

Possible Errors

404 Not Found: If the specified workflow does not exist.
400 Bad Request: If invalid query parameters are provided.

{
  "success": true,
  "nextPageToken": "abc123",
  "workflowRuns": [
  {
    "id": "workflow_run_1234",
    "status": "PROCESSED",
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedByUser": "user@example.com",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "workflowId": "workflow_1234",
    "workflowName": "My Workflow",    
    "workflowVersionId": "workflow_version_1234",
    "batchId": "batch_1234",
    "rejectionNote": "This workflow run was rejected because it was not valid.",
    "createdAt": "2023-01-01T09:41:00.000Z",
    "updatedAt": "2023-01-10T05:39:24.500Z"
  },
  {
    "id": "workflow_run_1235",
    "status": "FAILED",
    "initialRunAt": "2023-01-01T09:41:00.000Z",
    "reviewedByUser": "user@example.com",
    "reviewedAt": "2023-01-10T05:39:14.500Z",
    "startTime": "2023-01-01T09:41:00.000Z",
    "endTime": "2023-01-10T05:39:24.500Z",
    "workflowId": "workflow_1234",
    "workflowName": "My Workflow",    
    "workflowVersionId": "workflow_version_1234",
    "batchId": "batch_1234",
    "rejectionNote": "This workflow run was rejected because it was not valid.",
    "createdAt": "2023-01-01T09:41:00.000Z",
      "updatedAt": "2023-01-10T05:39:24.500Z"
    }
  ]
}

API Documentation

Workflow Endpoints

Processor Endpoints

Parse Endpoints

File Endpoints

Evaluation Set Endpoints

Objects

Guides

Webhooks

List Workflow Runs

Query Parameters

Response

Error Responses

Possible Errors

​Query Parameters

​Response

​Error Responses

​Possible Errors

Query Parameters

Response

Error Responses

Possible Errors