Docs

List Workflow runs

List retained runs for this Workflow, newest first. Each run corresponds to one matching Asset event.

GET
/workflows/{workflowId}/runs

Authorization

Authorization
header
string
required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Query Parameters

limit
default: 100
integer

Limit specifies the maximum number of results to return. Accepts 1 to 100. Defaults to 100.

Required range: 1 <= x <= 100
offset
default: 0
integer

Offset specifies the number of matching results to skip. Must be at least 0. Defaults to 0.

Required range: x >= 0
latest_per_asset
default: false
boolean

LatestPerAsset specifies whether to return only the latest matching run for each Asset. Defaults to false. Pagination and total count apply to Assets when true.

asset_id
string

AssetId specifies the Asset whose results to return. Omit it to include all Assets.

status
string

Status specifies the run status to filter by. Omit it to include all statuses.

Available options:
pendingrunningcompletedfailedcancelled
created.gte
integer

Created at or after this Unix timestamp in seconds.

created.lte
integer

Created at or before this Unix timestamp in seconds.

event_id
string

EventId specifies the triggering event ID to filter by. Omit it to include all events.

Path Parameters

workflowId
string
required

ID of the Workflow.

Responses

application/json
data
object[]
required

Workflow runs in this page.

limit
integer
required

Maximum number of results requested per page.

offset
integer
required

Number of matching results skipped.

status
"success"
string
required

Status of the API request. Always success for this response.

total
integer
required

Total number of results matching the filters before pagination.

List Workflow runs