For the complete documentation index, see llms.txt. This page is also available as Markdown.

Execution

Operations about executions

Retrieve all executions

get

Retrieve all executions from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Query parameters
includeDatabooleanOptional

Whether or not to include the execution's detailed data.

ignoreDataSizeLimitbooleanOptional

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.

redactExecutionDatabooleanOptional

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.

statusstring · enumOptional

Status to filter the executions by.

Possible values:
workflowIdstringOptional

Workflow to filter the executions by.

Example: 1000
projectIdstringOptionalExample: VmwOO9HeTEj20kxM
limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100
cursorstringOptional

Paginate 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.

Responses
200

Operation successful.

application/json
nextCursorstring · nullableOptional

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.

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA
get/executions

Retrieve an execution

get

Retrieve an execution from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
idnumberRequired

The ID of the execution.

Query parameters
includeDatabooleanOptional

Whether or not to include the execution's detailed data.

ignoreDataSizeLimitbooleanOptional

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.

redactExecutionDatabooleanOptional

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.

Responses
200

Operation successful.

application/json
idnumberOptionalExample: 1000
finishedbooleanOptionalExample: true
modestring · enumOptionalPossible values:
retryOfnumber · nullableOptional
retrySuccessIdnumber · nullableOptionalExample: 2
startedAtstring · date-timeOptional
stoppedAtstring · date-time · nullableOptional

The time at which the execution stopped. Will only be null for executions that still have the status 'running'.

workflowIdnumberOptionalExample: 1000
waitTillstring · date-time · nullableOptional
customDataobjectOptional
statusstring · enumOptionalPossible values:
get/executions/{id}

Delete an execution

delete

Deletes an execution from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
idnumberRequired

The ID of the execution.

Responses
200

Operation successful.

application/json
idnumberOptionalExample: 1000
finishedbooleanOptionalExample: true
modestring · enumOptionalPossible values:
retryOfnumber · nullableOptional
retrySuccessIdnumber · nullableOptionalExample: 2
startedAtstring · date-timeOptional
stoppedAtstring · date-time · nullableOptional

The time at which the execution stopped. Will only be null for executions that still have the status 'running'.

workflowIdnumberOptionalExample: 1000
waitTillstring · date-time · nullableOptional
customDataobjectOptional
statusstring · enumOptionalPossible values:
delete/executions/{id}

Retry an execution

post

Retry an execution from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
idnumberRequired

The ID of the execution.

Body
loadWorkflowbooleanOptional

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.

Responses
200

Operation successful.

application/json
idnumberOptionalExample: 1000
finishedbooleanOptionalExample: true
modestring · enumOptionalPossible values:
retryOfnumber · nullableOptional
retrySuccessIdnumber · nullableOptionalExample: 2
startedAtstring · date-timeOptional
stoppedAtstring · date-time · nullableOptional

The time at which the execution stopped. Will only be null for executions that still have the status 'running'.

workflowIdnumberOptionalExample: 1000
waitTillstring · date-time · nullableOptional
customDataobjectOptional
statusstring · enumOptionalPossible values:
post/executions/{id}/retry

Stop an execution

post

Stop an execution by id.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
idnumberRequired

The ID of the execution.

Responses
200

Operation successful.

application/json
idnumberOptionalExample: 1000
finishedbooleanOptionalExample: true
modestring · enumOptionalPossible values:
retryOfnumber · nullableOptional
retrySuccessIdnumber · nullableOptionalExample: 2
startedAtstring · date-timeOptional
stoppedAtstring · date-time · nullableOptional

The time at which the execution stopped. Will only be null for executions that still have the status 'running'.

workflowIdnumberOptionalExample: 1000
waitTillstring · date-time · nullableOptional
customDataobjectOptional
statusstring · enumOptionalPossible values:
post/executions/{id}/stop

Stop multiple executions

post

Stop multiple executions from your instance based on filter criteria.

Authorizations
X-N8N-API-KEYstringRequired
Body
workflowIdstringOptional

Optional workflow ID to filter executions. If not provided, will stop executions across all accessible workflows.

Example: 2tUt1wbLX592XDdX
startedAfterstring · date-timeOptional

Only stop executions that started after this time.

Example: 2024-01-01T00:00:00.000Z
startedBeforestring · date-timeOptional

Only stop executions that started before this time.

Example: 2024-12-31T23:59:59.999Z
Responses
200

Operation successful.

application/json
stoppednumberOptional

The number of executions that were successfully stopped.

Example: 5
post/executions/stop

Get execution tags

get

Get annotation tags for an execution.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
idnumberRequired

The ID of the execution.

Responses
200

List of annotation tags

application/json
idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX
namestringRequiredExample: Production
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
get/executions/{id}/tags

Update tags of an execution

put

Update annotation tags of an execution.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
idnumberRequired

The ID of the execution.

Bodyobject[]
idstringRequiredExample: 2tUt1wbLX592XDdX
Responses
200

List of tags after updating

application/json
idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX
namestringRequiredExample: Production
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
put/executions/{id}/tags

Last updated

Was this helpful?