workflows

Get workflow executions

Changed on

Spaces method and path for this operation:

<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/workflows/workflow/{workflowId}/executions</span></div>

Refer to Spaces for more information.

Retrieve a paginated list of executions for a specific workflow.<br/><br/>[Required authorization] Route required privileges: workflowsManagement:read AND workflowsManagement:readExecution. Extended privileges (optional, expand functionality when granted): workflowsManagement:managed:readExecution.

get/api/workflows/workflow/{workflowId}/executions

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/workflows/workflow/{workflowId}/executions
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

workflowIdstring required

Workflow ID

Query parameters

statusesstring[]

Filter by execution status.

executionTypesstring[]

Filter by execution type.

executedBystring[]

Filter by the user who triggered the execution.

concurrencyGroupKeystring

Filter by evaluated concurrency group key.

omitStepRunsboolean

Whether to exclude step-level execution data.

finishedAfterstring

Datemath lower bound for filtering executions by finishedAt (inclusive when parsed).

finishedBeforestring

Datemath upper bound for filtering executions by finishedAt (inclusive when parsed with roundUp).

collapse'concurrencyGroupKey' | 'status' | 'executedBy' | 'triggeredBy'

Field to collapse execution results by.

sortField'createdAt' | 'finishedAt'

Field to sort executions by.

sortOrder'asc' | 'desc'

Sort order.

pagenumber

Page number.

sizenumber

Number of results per page.

searchAfterstring

JSON-encoded search_after sort values from a prior response for cursor pagination.

startedAfterstring

Datemath lower bound for filtering executions by startedAt (inclusive when parsed).

startedBeforestring

Datemath upper bound for filtering executions by startedAt (inclusive when parsed with roundUp).

Response

Indicates a successful response

Changes