List Workflows Executions

GET

/admin/workflows-executions

Workflows Executions

Retrieve a list of workflows executions. The workflows executions can be filtered by fields such as id. The workflows executions can also be sorted or paginated.

Response Example

200 - Example 1

{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "workflow_executions": [
        {
            "execution": {
                "steps": {
                    "property1": {
                        "id": "string",
                        "depth": 0,
                        "startedAt": 0,
                        "invoke": {
                            "state": "failed",
                            "status": "idle"
                        },
                        "compensate": {
                            "state": "failed",
                            "status": "idle"
                        },
                        "definition": {
                            "async": true,
                            "compensateAsync": true,
                            "noCompensation": true,
                            "continueOnPermanentFailure": true,
                            "maxRetries": 0,
                            "noWait": false,
                            "retryInterval": 0,
                            "retryIntervalAwaiting": 0,
                            "saveResponse": true,
                            "timeout": 0,
                            "skipOnPermanentFailure": "string"
                        }
                    },
                    "property2": {
                        "id": "string",
                        "depth": 0,
                        "startedAt": 0,
                        "invoke": {
                            "state": "failed",
                            "status": "idle"
                        },
                        "compensate": {
                            "state": "failed",
                            "status": "idle"
                        },
                        "definition": {
                            "async": true,
                            "compensateAsync": true,
                            "noCompensation": true,
                            "continueOnPermanentFailure": true,
                            "maxRetries": 0,
                            "noWait": false,
                            "retryInterval": 0,
                            "retryIntervalAwaiting": 0,
                            "saveResponse": true,
                            "timeout": 0,
                            "skipOnPermanentFailure": "string"
                        }
                    }
                }
            },
            "context": {
                "compensate": {},
                "errors": [
                    {
                        "error": {},
                        "action": "string",
                        "handlerType": "string"
                    }
                ],
                "data": {
                    "payload": null,
                    "invoke": {
                        "property1": {
                            "output": {
                                "output": null,
                                "compensateInput": null
                            }
                        },
                        "property2": {
                            "output": {
                                "output": null,
                                "compensateInput": null
                            }
                        }
                    }
                }
            },
            "id": "string",
            "workflow_id": "string",
            "transaction_id": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "state": "not_started"
        }
    ]
}

Request

Authorization

Query Params

fields

string

fields

optional

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

offset

number

offset

optional

The number of items to skip when retrieving a list.

limit

number

limit

optional

Limit the number of items returned in the list.

order

string

order

optional

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

transaction_id

optional

One of

transaction_id

array[string]

Filter by a transaction ID.

workflow_id

optional

One of

workflow_id

array[string]

Filter by a workflow ID.

string

optional

Search query to filter by a workflow execution's searchable fields.

Responses

🟢200OK

application/json

Body

The paginated list of workflow executions.

limit

number

limit

required

The maximum number of items returned.

offset

number

offset

required

The number of items skipped before retrieving the returned items.

count

number

count

required

The total number of items.

workflow_executions

array[object (AdminWorkflowExecution) {9}]

required

The workflows execution's workflow executions.

execution

object

AdminWorkflowExecutionExecution

required

The workflow execution's steps details.

context

object

WorkflowExecutionContext

required

The workflow execution's context.

string

required

The workflow execution's ID.

workflow_id

string

workflow_id

required

The ID of the workflow.

transaction_id

string

transaction_id

required

The workflow execution's transaction ID.

created_at

string <date-time>

created_at

required

The date the workflow execution was created.

updated_at

string <date-time>

updated_at

required

The date the workflow execution was updated.

deleted_at

string <date-time>

deleted_at

optional

The date the workflow execution was deleted.

state

enum<string>

required

The workflow execution's state.

Allowed values:

not_startedinvokingwaiting_to_compensatecompensatingdonerevertedfailed

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

🟠422Parameter Error

🔴500Server Error

Modified at 2025-06-17 04:10:32

Succeed a Step in a Workflow's Execution

Execute a Workflow