Skip to main content

List Runs

GET/api/v1/workflow/{workflow_id}/runs

Get workflow runs with optional filtering and sorting. Filters should be provided as a JSON-encoded array of filter criteria. Example: [{"attribute": "dateRange", "value": {"from": "2024-01-01", "to": "2024-01-31"}}]

cURL example

curl -X GET \
  'http://localhost:8000/api/v1/workflow/{workflow_id}/runs' \
  -H 'Authorization: Bearer <API_KEY>'

Parameters

NameLocationTypeDescription
workflow_idrequiredpathinteger
pagequeryintegerPage number (starts from 1)
limitqueryintegerNumber of items per page
filtersqueryobjectJSON-encoded filter criteria
sort_byqueryobjectField to sort by (e.g., 'duration', 'created_at')
sort_orderqueryobjectSort order ('asc' or 'desc')
authorizationheaderobject
X-API-Keyheaderobject

Responses

200Successful Response
application/json
View schema
{
  "$ref": "#/components/schemas/WorkflowRunsResponse"
}
404Not found
422Validation Error
application/json
View schema
{
  "$ref": "#/components/schemas/HTTPValidationError"
}