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

Executions

Operations about executions

Retrieve all executions

get
/executions

Retrieve all executions from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Query parameters
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.

includeDatastring · enumOptional

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

Default: falsePossible values:
ignoreDataSizeLimitstring · enumOptional

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.

Default: falsePossible values:
redactExecutionDatastring · enumOptional

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.

Possible values:
statusstring · enumOptional

Status to filter the executions by.

Possible values:
workflowIdstringOptional

Workflow to filter the executions by.

Example: 1000
projectIdstringOptionalExample: VmwOO9HeTEj20kxM
startedAfterstring · date-timeOptional

Only return executions that started after this time.

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

Only return executions that started before this time.

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

Operation successful.

application/json
nextCursorstring · nullableRequired

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: eyJsYXN0SWQiOiIxMDAwIiwibGltaXQiOjEwMH0=
get/executions
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

get
/executions/{executionId}

Retrieve an execution from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
executionIdinteger · min: 1Required

The ID of the execution.

Query parameters
includeDatastring · enumOptional

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

Default: falsePossible values:
ignoreDataSizeLimitstring · enumOptional

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.

Default: falsePossible values:
redactExecutionDatastring · enumOptional

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.

Possible values:
Responses
200

Operation successful.

application/json
idstringRequiredExample: 1000
finishedbooleanRequiredDeprecated

Whether the execution ran to completion. Use status instead.

Example: true
modestring · enumRequiredExample: manualPossible values:
retryOfstring · nullableRequired

ID of the execution this one is a retry of.

retrySuccessIdstring · nullableRequired

ID of the retry that succeeded, if this execution failed and a retry did not.

Example: 2
statusstring · enumRequiredPossible values:
createdAtstring · date-timeRequired
startedAtstring · date-time · nullableRequired

Null until the execution leaves the queue and starts running.

stoppedAtstring · date-time · nullableRequired

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.

deletedAtstring · date-time · nullableRequired

Always null. Soft-deleted executions are not returned.

workflowIdstringRequiredExample: 1000
waitTillstring · date-time · nullableRequired

The time at which a waiting execution resumes.

storedAtstring · enumRequired

Where the execution data is stored.

Possible values:
deduplicationKeystring · nullableRequired

Key used to stop a duplicate execution from being created.

jsonSizeBytesnumberRequired

Size of the stored execution data in bytes. 0 means unknown.

Example: 0
binaryDataSizeBytesnumberRequired

Size of the stored binary data in bytes. 0 means unknown.

Example: 0
workflowVersionIdstring · nullableRequired

ID of the workflow version this execution ran.

usedPrivateCredentialsbooleanRequired

Whether the execution used credentials that are not shared with the project.

Example: false
dataTooLargeToDisplaybooleanOptional

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

get/executions/{executionId}
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
}

Delete an execution

delete
/executions/{executionId}

Deletes an execution from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
executionIdinteger · min: 1Required

The ID of the execution.

Responses
200

Operation successful.

application/json
idnumberRequired

ID of the deleted execution. This endpoint returns it as a number, where every other execution endpoint returns a string.

Example: 1000
finishedbooleanRequiredDeprecated

Whether the execution ran to completion. Use status instead.

Example: true
modestring · enumRequiredExample: manualPossible values:
retryOfstring · nullableRequired

ID of the execution this one is a retry of.

retrySuccessIdstring · nullableRequired

ID of the retry that succeeded, if this execution failed and a retry did not.

Example: 2
statusstring · enumRequiredPossible values:
createdAtstring · date-timeRequired
startedAtstring · date-time · nullableRequired

Null until the execution leaves the queue and starts running.

stoppedAtstring · date-time · nullableRequired

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.

deletedAtstring · date-time · nullableRequired

Always null. Soft-deleted executions are not returned.

workflowIdstringRequiredExample: 1000
waitTillstring · date-time · nullableRequired

The time at which a waiting execution resumes.

storedAtstring · enumRequired

Where the execution data is stored.

Possible values:
deduplicationKeystring · nullableRequired

Key used to stop a duplicate execution from being created.

jsonSizeBytesnumberRequired

Size of the stored execution data in bytes. 0 means unknown.

Example: 0
binaryDataSizeBytesnumberRequired

Size of the stored binary data in bytes. 0 means unknown.

Example: 0
workflowVersionIdstring · nullableRequired

ID of the workflow version this execution ran.

usedPrivateCredentialsbooleanRequired

Whether the execution used credentials that are not shared with the project.

Example: false
delete/executions/{executionId}
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 execution tags

get
/executions/{executionId}/tags

Get annotation tags for an execution.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
executionIdinteger · min: 1Required

The ID of the execution.

Responses
200

Operation successful.

application/json
idstringRead-onlyRequiredExample: 2tUt1wbLX592XDdX
namestringRequiredExample: Production
createdAtstring · date-timeRead-onlyRequired
updatedAtstring · date-timeRead-onlyRequired
get/executions/{executionId}/tags
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 tags of an execution

put
/executions/{executionId}/tags

Update annotation tags of an execution.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
executionIdinteger · min: 1Required

The ID of the execution.

Bodyobject[]
idstringRequiredExample: 2tUt1wbLX592XDdX
Responses
200

Operation successful.

application/json
idstringRead-onlyRequiredExample: 2tUt1wbLX592XDdX
namestringRequiredExample: Production
createdAtstring · date-timeRead-onlyRequired
updatedAtstring · date-timeRead-onlyRequired
put/executions/{executionId}/tags
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

post
/executions/stop

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. The literal value all has the same effect as omitting it.

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
stoppedintegerRequired

The number of executions that were successfully stopped.

Example: 5
post/executions/stop
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

post
/executions/{executionId}/stop

Stop an execution by id.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
executionIdinteger · min: 1Required

The ID of the execution.

Responses
200

Operation successful.

application/json
modestring · enumRequiredExample: manualPossible values:
startedAtstring · date-timeRequired

The time at which the execution started.

stoppedAtstring · date-timeOptional

The time at which the execution stopped. Absent when no stop time was recorded.

finishedbooleanRequiredDeprecated

Whether the execution ran to completion. Use status instead.

Example: false
statusstring · enumRequiredExample: canceledPossible values:
post/executions/{executionId}/stop
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

post
/executions/{executionId}/retry

Retry an execution from your instance.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
executionIdinteger · min: 1Required

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
idstringRequired

ID of the new execution that the retry started.

Example: 1001
modestring · enumRequiredExample: retryPossible values:
startedAtstring · date-time · nullableRequired

The time at which the new execution started.

workflowIdstringRequiredExample: 1000
finishedbooleanRequiredDeprecated

Whether the execution ran to completion. Use status instead.

Example: true
retryOfstring · nullableRequired

ID of the execution this one is a retry of.

statusstring · enumRequiredPossible values:
waitTillstring · date-time · nullableOptional

The time at which a waiting execution resumes.

storedAtstring · enumRequired

Where the execution data is stored.

Possible values:
post/executions/{executionId}/retry
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?