Get Workflow Executions

The Workflow Executions API manages the execution instances of workflows. When a workflow is triggered, a workflow execution record is created to track its progress, status, and results. Each execution contains the workflow's nodes and edges at the time of execution, execution data, and metadata about the run.

Purpose

Workflow executions serve as:

Execution History: Track every time a workflow runs with complete state

Real-time Monitoring: Monitor currently running workflows with status updates

Debugging & Auditing: Review past executions to debug issues or audit workflow behavior

Approval Management: Track pending approvals within workflow executions

Analytics: Aggregate execution data for insights and reporting

Key Concepts

Execution Status: Workflows can be in various states (running, pending, paused, waiting, completed, failed, cancelled)

Workspace & Organization Scoping: Executions are scoped to workspaces and can be filtered by workspace UUID or organization Multiplai ID

Approval Workflows: Some executions may contain approval steps that pause execution until human review

Child Workflows: Workflows can trigger other workflows, creating parent-child relationships

Real-time Updates: Executions broadcast status changes via WebSocket channels for live monitoring

Available Endpoints

List Workflow Executions

GET /v1/workflow-executions

Retrieve paginated workflow executions with flexible filtering options.

Filtering Options:

Filter by specific workflow(s): workflow_uuid or workflow_uuids[]

Filter by workspace: workspace_uuid or organization_multiplai_id

At least one filter is required (workspace/organization OR workflow identifier)

workspace_uuid takes precedence over organization_multiplai_id when both provided

Additional Features:

Search execution content

Sort by created_at or updated_at

Eager load relationships: with=workflow,workflowExecutionData

Include counts: with_count=workflowApprovals,pendingWorkflowApprovals

Pagination support

Get Workflow Execution

GET /v1/workflow-executions/{uuid}

Retrieve a single workflow execution with optional relationship loading.

Create Workflow Execution

POST /v1/workflow-executions

Create a new workflow execution. Typically triggered internally when workflows are executed, but can be called directly for manual execution tracking.

Update Workflow Execution

PUT/PATCH /v1/workflow-executions/{uuid}

Update an existing workflow execution's properties.

Delete Workflow Execution

DELETE /v1/workflow-executions/{uuid}

Soft delete a workflow execution. Preserves data while marking it as deleted.

Stop Workflow Execution

POST /v1/workflow-executions/{uuid}/stop

Cancel a running, pending, paused, or waiting workflow execution. Automatically cancels any child workflows and parent workflows that are waiting for this execution.

Stoppable Statuses:

Running

Pending

Paused

Waiting

Get Execution Count

GET /v1/workflow-executions/count

Get aggregated count of workflow executions within a date range.

Filters:

Required: workspace_uuid or multiplai_id, start_date, end_date

Optional: status, requires_human_review, has_command_room_task

Useful for analytics, dashboards, and reporting features.

Common Use Cases

Monitor Active Workflows: Query executions with status=running to see currently executing workflows

Review History: Filter by workspace and date range to review past workflow activity

Approval Management: Use with_count=pendingWorkflowApprovals to identify executions awaiting approval

Debugging: Retrieve specific execution with with=workflowExecutionData to inspect detailed execution logs

Organization Reporting: Filter by organization_multiplai_id to aggregate execution data across multiple workspaces

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

curl --location -g --request GET 'https://localhost/api/v1/workflow-executions?workspace_uuid={{workspace_uuid}}&organization_multiplai_id=org-123&user_multiplai_id=user-123&workflow_uuid={{workflow_uuid}}&workflow_uuids=uuid1&workflow_uuids=uuid2&search=&page=&sort_by=&sort_direction=&date_from=2025-01-01&date_to=2025-01-31&with=&with_count=' \ --header 'X-Multiplai-Authorization;' \ --header 'Authorization: Bearer <token>'

{ "data": [ { "id": 1, "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "is_finished": true, "mode": "string", "retry_of": "string", "retry_success_id": "string", "started_at": "2019-08-24T14:15:22.123Z", "stopped_at": "2019-08-24T14:15:22.123Z", "wait_till": "2019-08-24T14:15:22.123Z", "status": "pending", "created_at": "2019-08-24T14:15:22.123Z", "updated_at": "2019-08-24T14:15:22.123Z", "deleted_at": "2019-08-24T14:15:22.123Z", "workflow": { "id": 42, "uuid": "550e8400-e29b-41d4-a716-446655440000", "user_id": 15, "workspace_id": 3, "template_id": null, "name": "Customer Onboarding Flow", "description": "Automated workflow for onboarding new customers", "profile_photo_url": null, "profile_photo_config": null, "visibility": "workspace", "is_active": true, "is_owner": true, "is_favorite": false, "trigger_count": 2, "allow_cloning": true, "allow_account_usage": false, "last_used_at": "2026-02-10T14:30:00.000000Z", "created_at": "2026-01-15T10:00:00.000000Z", "updated_at": "2026-02-10T09:15:00.000000Z", "deleted_at": null, "executions_count": 156, "executions_in_progress_count": 3, "executions_for_review_count": 7, "executions_completed_count": 142 }, "workflow_execution_data": [ { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "workflow_data": [ { "status": "error", "output": {}, "started_at": "2019-08-24T14:15:22.123Z", "stopped_at": "2019-08-24T14:15:22.123Z" } ], "metadata": { "running_node": "string", "workflow_execution_data_id": 1, "execution_time": 0, "wait_until": "2019-08-24T14:15:22.123Z", "wait_until_timestamp": 0, "wait_started_at": "2019-08-24T14:15:22.123Z", "wait_completed_at": "2019-08-24T14:15:22.123Z", "loop_index": 0, "processed_count": 0, "error_count": 0, "retry_count": 0, "property1": "string", "property2": "string" }, "data": "string", "created_at": "2019-08-24T14:15:22.123Z", "updated_at": "2019-08-24T14:15:22.123Z", "deleted_at": "2019-08-24T14:15:22.123Z" } ] } ], "meta": { "current_page": 3, "from": 21, "last_page": 10, "per_page": 20, "to": 40, "total": 195, "path": "https://api.example.com/users" }, "links": { "first": "https://api.example.com/users?page=1", "last": "https://api.example.com/users?page=10", "prev": "https://api.example.com/users?page=2", "next": "https://api.example.com/users?page=4" } }

Get Workflow Executions

Purpose

Key Concepts

Available Endpoints

List Workflow Executions

Get Workflow Execution

Create Workflow Execution

Update Workflow Execution

Delete Workflow Execution

Stop Workflow Execution

Get Execution Count

Common Use Cases

Request

Responses

Get Workflow Executions

Purpose#

Key Concepts#

Available Endpoints#

List Workflow Executions#

Get Workflow Execution#

Create Workflow Execution#

Update Workflow Execution#

Delete Workflow Execution#

Stop Workflow Execution#

Get Execution Count#

Common Use Cases#

Request

Responses

Purpose

Key Concepts

Available Endpoints

List Workflow Executions

Get Workflow Execution

Create Workflow Execution

Update Workflow Execution

Delete Workflow Execution

Stop Workflow Execution

Get Execution Count

Common Use Cases