Executions
Operations about executions
Retrieve all executions from your instance.
The maximum number of items to return.
100Example: 100Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.
Whether or not to include the execution's detailed data.
falsePossible values: Whether to return the full execution data even if it exceeds the configured size limit (EXECUTIONS_DATA_MAX_DISPLAY_SIZE). Oversized executions are otherwise returned without their data.
falsePossible values: Controls execution data redaction. When true, execution output data is always redacted. When false, requests unredacted (revealed) data — requires the execution:reveal scope. When omitted, follows the workflow redaction policy.
Status to filter the executions by.
Workflow to filter the executions by.
1000VmwOO9HeTEj20kxMOnly return executions that started after this time.
2024-01-01T00:00:00.000ZOnly return executions that started before this time.
2024-12-31T23:59:59.999ZOperation successful.
Paginate through executions by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.
eyJsYXN0SWQiOiIxMDAwIiwibGltaXQiOjEwMH0=The request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
GET /api/v1/executions HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*
{
"data": [
{
"id": "1000",
"mode": "manual",
"retryOf": "text",
"retrySuccessId": "2",
"status": "canceled",
"startedAt": "2026-01-01T00:00:00.000Z",
"stoppedAt": "2026-01-01T00:00:00.000Z",
"workflowId": "1000",
"waitTill": "2026-01-01T00:00:00.000Z",
"storedAt": "db",
"jsonSizeBytes": 0,
"workflowVersionId": "text",
"data": {
"redactionInfo": {
"isRedacted": true,
"reason": "text",
"canReveal": true
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"workflowData": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"customData": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"dataTooLargeToDisplay": true
}
],
"nextCursor": "eyJsYXN0SWQiOiIxMDAwIiwibGltaXQiOjEwMH0="
}Retrieve an execution from your instance.
The ID of the execution.
Whether or not to include the execution's detailed data.
falsePossible values: Whether to return the full execution data even if it exceeds the configured size limit (EXECUTIONS_DATA_MAX_DISPLAY_SIZE). Oversized executions are otherwise returned without their data.
falsePossible values: Controls execution data redaction. When true, execution output data is always redacted. When false, requests unredacted (revealed) data — requires the execution:reveal scope. When omitted, follows the workflow redaction policy.
Operation successful.
1000Whether the execution ran to completion. Use status instead.
truemanualPossible values: ID of the execution this one is a retry of.
ID of the retry that succeeded, if this execution failed and a retry did not.
2Null until the execution leaves the queue and starts running.
When the execution stopped. Null for the new, running and unknown statuses; a waiting execution has stopped its current run, so it has a value.
Always null. Soft-deleted executions are not returned.
1000The time at which a waiting execution resumes.
Where the execution data is stored.
Key used to stop a duplicate execution from being created.
Size of the stored execution data in bytes. 0 means unknown.
0Size of the stored binary data in bytes. 0 means unknown.
0ID of the workflow version this execution ran.
Whether the execution used credentials that are not shared with the project.
falsePresent and true when the execution data was larger than EXECUTIONS_DATA_MAX_DISPLAY_SIZE. data is then empty and jsonSizeBytes holds the real size. Use ignoreDataSizeLimit to read it anyway.
The request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
GET /api/v1/executions/{executionId} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*
{
"id": "1000",
"mode": "manual",
"retryOf": "text",
"retrySuccessId": "2",
"status": "canceled",
"createdAt": "2026-01-01T00:00:00.000Z",
"startedAt": "2026-01-01T00:00:00.000Z",
"stoppedAt": "2026-01-01T00:00:00.000Z",
"deletedAt": "2026-01-01T00:00:00.000Z",
"workflowId": "1000",
"waitTill": "2026-01-01T00:00:00.000Z",
"storedAt": "db",
"tracingContext": {
"traceparent": "text",
"tracestate": "text"
},
"deduplicationKey": "text",
"jsonSizeBytes": 0,
"binaryDataSizeBytes": 0,
"workflowVersionId": "text",
"usedPrivateCredentials": false,
"data": {
"redactionInfo": {
"isRedacted": true,
"reason": "text",
"canReveal": true
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"customData": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"workflowData": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"dataTooLargeToDisplay": true
}Deletes an execution from your instance.
The ID of the execution.
Operation successful.
ID of the deleted execution. This endpoint returns it as a number, where every other execution endpoint returns a string.
1000Whether the execution ran to completion. Use status instead.
truemanualPossible values: ID of the execution this one is a retry of.
ID of the retry that succeeded, if this execution failed and a retry did not.
2Null until the execution leaves the queue and starts running.
When the execution stopped. Null for the new, running and unknown statuses; a waiting execution has stopped its current run, so it has a value.
Always null. Soft-deleted executions are not returned.
1000The time at which a waiting execution resumes.
Where the execution data is stored.
Key used to stop a duplicate execution from being created.
Size of the stored execution data in bytes. 0 means unknown.
0Size of the stored binary data in bytes. 0 means unknown.
0ID of the workflow version this execution ran.
Whether the execution used credentials that are not shared with the project.
falseThe request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
DELETE /api/v1/executions/{executionId} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*
{
"id": 1000,
"mode": "manual",
"retryOf": "text",
"retrySuccessId": "2",
"status": "canceled",
"createdAt": "2026-01-01T00:00:00.000Z",
"startedAt": "2026-01-01T00:00:00.000Z",
"stoppedAt": "2026-01-01T00:00:00.000Z",
"deletedAt": "2026-01-01T00:00:00.000Z",
"workflowId": "1000",
"waitTill": "2026-01-01T00:00:00.000Z",
"storedAt": "db",
"tracingContext": {
"traceparent": "text",
"tracestate": "text"
},
"deduplicationKey": "text",
"jsonSizeBytes": 0,
"binaryDataSizeBytes": 0,
"workflowVersionId": "text",
"usedPrivateCredentials": false
}Get annotation tags for an execution.
The ID of the execution.
Operation successful.
2tUt1wbLX592XDdXProductionThe request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
GET /api/v1/executions/{executionId}/tags HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*
[
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
]Update annotation tags of an execution.
The ID of the execution.
2tUt1wbLX592XDdXOperation successful.
2tUt1wbLX592XDdXProductionThe request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
Unsupported media type.
PUT /api/v1/executions/{executionId}/tags HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 27
[
{
"id": "2tUt1wbLX592XDdX"
}
][
{
"id": "2tUt1wbLX592XDdX",
"name": "Production",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z"
}
]Stop multiple executions from your instance based on filter criteria.
Optional workflow ID to filter executions. If not provided, will stop executions across all accessible workflows. The literal value all has the same effect as omitting it.
2tUt1wbLX592XDdXOnly stop executions that started after this time.
2024-01-01T00:00:00.000ZOnly stop executions that started before this time.
2024-12-31T23:59:59.999ZOperation successful.
The number of executions that were successfully stopped.
5The request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
Unsupported media type.
POST /api/v1/executions/stop HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 158
{
"status": [
"queued",
"running",
"waiting"
],
"workflowId": "2tUt1wbLX592XDdX",
"startedAfter": "2024-01-01T00:00:00.000Z",
"startedBefore": "2024-12-31T23:59:59.999Z"
}{
"stopped": 5
}Stop an execution by id.
The ID of the execution.
Operation successful.
manualPossible values: The time at which the execution started.
The time at which the execution stopped. Absent when no stop time was recorded.
Whether the execution ran to completion. Use status instead.
falsecanceledPossible values: The request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
Conflict
POST /api/v1/executions/{executionId}/stop HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*
{
"mode": "manual",
"startedAt": "2026-01-01T00:00:00.000Z",
"stoppedAt": "2026-01-01T00:00:00.000Z",
"status": "canceled"
}Retry an execution from your instance.
The ID of the execution.
Whether to load the currently saved workflow to execute instead of the one saved at the time of the execution. If set to true, it will retry with the latest version of the workflow.
Operation successful.
ID of the new execution that the retry started.
1001retryPossible values: The time at which the new execution started.
1000Whether the execution ran to completion. Use status instead.
trueID of the execution this one is a retry of.
The time at which a waiting execution resumes.
Where the execution data is stored.
The request is invalid or provides malformed data.
Unauthorized
Forbidden
The specified resource was not found.
Conflict
Unsupported media type.
POST /api/v1/executions/{executionId}/retry HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"loadWorkflow": true
}{
"id": "1001",
"mode": "retry",
"startedAt": "2026-01-01T00:00:00.000Z",
"workflowId": "1000",
"retryOf": "text",
"status": "canceled",
"waitTill": "2026-01-01T00:00:00.000Z",
"data": {
"redactionInfo": {
"isRedacted": true,
"reason": "text",
"canReveal": true
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"workflowData": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"customData": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"annotation": {
"id": 1,
"vote": "up",
"tags": [
{
"id": "text",
"name": "text"
}
]
},
"storedAt": "db"
}Last updated
Was this helpful?