Workflow

Operations about workflows

Retrieve all workflows

get

Retrieve all workflows from your instance.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Query parameters

activebooleanOptionalExample: true

tagsstringOptionalExample: test,production

namestringOptionalExample: My Workflow

projectIdstringOptionalExample: VmwOO9HeTEj20kxM

excludePinnedDatabooleanOptional

Set this to avoid retrieving pinned data

Example: true

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 workflows 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

401

Unauthorized

get/workflows

HTTPcURLJavaScriptPython

GET /api/v1/workflows HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Workflow 1",
      "description": "My workflow description",
      "active": true,
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z",
      "isArchived": true,
      "versionId": "text",
      "triggerCount": 1,
      "nodes": [
        {
          "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
          "name": "Jira",
          "webhookId": "text",
          "disabled": true,
          "notesInFlow": true,
          "notes": "text",
          "type": "n8n-nodes-base.jira",
          "typeVersion": 1,
          "executeOnce": false,
          "alwaysOutputData": false,
          "retryOnFail": false,
          "maxTries": 1,
          "waitBetweenTries": 1,
          "onError": "stopWorkflow",
          "position": [
            -100,
            80
          ],
          "parameters": {
            "additionalProperties": {}
          },
          "credentials": {
            "jiraSoftwareCloudApi": {
              "id": "35",
              "name": "jiraApi"
            }
          },
          "customTelemetryTags": {
            "tag": [
              {
                "key": "text",
                "value": "text"
              }
            ]
          },
          "createdAt": "2026-07-19T15:34:20.583Z",
          "updatedAt": "2026-07-19T15:34:20.583Z"
        }
      ],
      "connections": {
        "Jira": {
          "main": [
            [
              {
                "node": "Jira",
                "type": "main",
                "index": 0
              }
            ]
          ]
        }
      },
      "nodeGroups": [
        {
          "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
          "name": "Data processing",
          "nodeIds": [
            "text"
          ]
        }
      ],
      "settings": {
        "saveExecutionProgress": true,
        "saveManualExecutions": true,
        "saveDataErrorExecution": "all",
        "saveDataSuccessExecution": "all",
        "executionTimeout": 3600,
        "errorWorkflow": "VzqKEW0ShTXA5vPj",
        "timezone": "America/New_York",
        "executionOrder": "v1",
        "callerPolicy": "workflowsFromSameOwner",
        "callerIds": "14, 18, 23",
        "timeSavedPerExecution": 1,
        "redactionPolicy": "non-manual",
        "availableInMCP": false,
        "customTelemetryTags": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "staticData": {
        "lastId": 1
      },
      "pinData": {},
      "meta": {
        "onboardingId": "text",
        "templateId": "text",
        "instanceId": "text",
        "templateCredsSetupCompleted": true
      },
      "tags": [
        {
          "id": "2tUt1wbLX592XDdX",
          "name": "Production",
          "createdAt": "2026-07-19T15:34:20.583Z",
          "updatedAt": "2026-07-19T15:34:20.583Z"
        }
      ],
      "shared": [
        {
          "role": "workflow:owner",
          "workflowId": "2tUt1wbLX592XDdX",
          "projectId": "2tUt1wbLX592XDdX",
          "project": {
            "id": "text",
            "name": "text",
            "type": "text"
          },
          "createdAt": "2026-07-19T15:34:20.583Z",
          "updatedAt": "2026-07-19T15:34:20.583Z"
        }
      ],
      "activeVersion": {
        "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
        "workflowId": "2tUt1wbLX592XDdX",
        "nodes": [
          {
            "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
            "name": "Jira",
            "webhookId": "text",
            "disabled": true,
            "notesInFlow": true,
            "notes": "text",
            "type": "n8n-nodes-base.jira",
            "typeVersion": 1,
            "executeOnce": false,
            "alwaysOutputData": false,
            "retryOnFail": false,
            "maxTries": 1,
            "waitBetweenTries": 1,
            "onError": "stopWorkflow",
            "position": [
              -100,
              80
            ],
            "parameters": {
              "additionalProperties": {}
            },
            "credentials": {
              "jiraSoftwareCloudApi": {
                "id": "35",
                "name": "jiraApi"
              }
            },
            "customTelemetryTags": {
              "tag": [
                {
                  "key": "text",
                  "value": "text"
                }
              ]
            },
            "createdAt": "2026-07-19T15:34:20.583Z",
            "updatedAt": "2026-07-19T15:34:20.583Z"
          }
        ],
        "connections": {
          "Jira": {
            "main": [
              [
                {
                  "node": "Jira",
                  "type": "main",
                  "index": 0
                }
              ]
            ]
          }
        },
        "nodeGroups": [
          {
            "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
            "name": "Data processing",
            "nodeIds": [
              "text"
            ]
          }
        ],
        "authors": "1,2,3",
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Create a workflow

post

Create a workflow in your instance.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Body

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

projectIdstringOptional

Target project to create the workflow in. Defaults to the user's personal project.

Example: VmwOO9HeTEj20kxM

Responses

200

A workflow object

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

400

The request is invalid or provides malformed data.

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/workflows

HTTPcURLJavaScriptPython

POST /api/v1/workflows HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1342

{
  "name": "Workflow 1",
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      }
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "projectId": "VmwOO9HeTEj20kxM",
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "name": "text"
      }
    }
  ]
}

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Retrieve a workflow

get

Retrieve a workflow.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Query parameters

excludePinnedDatabooleanOptional

Set this to avoid retrieving pinned data

Example: true

Responses

200

Operation successful.

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

401

Unauthorized

404

The specified resource was not found.

get/workflows/{id}

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Update a workflow

put

Update a workflow. If the workflow is published, the updated version will be automatically re-published.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Body

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

Responses

200

Workflow object

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

put/workflows/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/workflows/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1351

{
  "name": "Workflow 1",
  "description": "My workflow description",
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      }
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "name": "text"
      }
    }
  ]
}

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Delete a workflow

delete

Delete a workflow.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Responses

200

Operation successful.

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

401

Unauthorized

404

The specified resource was not found.

delete/workflows/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/workflows/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Retrieves a specific version of a workflow

get

Retrieves a specific version of a workflow from workflow history.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

versionIdstringRequired

The version ID to retrieve

Example: abc123-def456-ghi789

Responses

200

Operation successful.

application/json

versionIdstringRead-onlyRequired

The version ID of this workflow snapshot

Example: abc123-def456

workflowIdstringRead-onlyRequired

The workflow ID this version belongs to

Example: 2tUt1wbLX592XDdX

connectionsobjectRead-onlyRequired

Connections as they were in this version

Example: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

authorsstringRead-onlyRequired

Authors who created this version

Example: John Doe

namestring · nullableOptional

Workflow name at this version

Example: Workflow 1

descriptionstring · nullableOptional

Workflow description at this version

createdAtstring · date-timeRead-onlyOptional

When this version was created

updatedAtstring · date-timeRead-onlyOptional

When this version was last updated

401

Unauthorized

404

The specified resource was not found.

get/workflows/{id}/{versionId}

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{id}/{versionId} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "versionId": "abc123-def456",
  "workflowId": "2tUt1wbLX592XDdX",
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "authors": "John Doe",
  "name": "Workflow 1",
  "description": "text",
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z"
}

Publish a workflow

post

Publish a workflow. In n8n v1, this action was termed activating a workflow.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Body

application/json

versionIdstringOptional

The specific version ID to activate or publish. If not provided, the latest version is used.

namestringOptional

Optional name for the workflow version during activation.

descriptionstringOptional

Optional description for the workflow version during activation.

Responses

200

Workflow object

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

post/workflows/{id}/activate

HTTPcURLJavaScriptPython

POST /api/v1/workflows/{id}/activate HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "versionId": "text",
  "name": "text",
  "description": "text"
}

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Deactivate a workflow

post

Deactivate a workflow.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Responses

200

Workflow object

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

401

Unauthorized

404

The specified resource was not found.

post/workflows/{id}/deactivate

HTTPcURLJavaScriptPython

POST /api/v1/workflows/{id}/deactivate HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Archive a workflow

post

Soft-deletes a workflow by archiving it. Idempotent: archiving an already archived workflow returns 200 with the current workflow.

Requires API key scope workflow:delete.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Responses

200

Archived workflow

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

post/workflows/{id}/archive

HTTPcURLJavaScriptPython

POST /api/v1/workflows/{id}/archive HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Unarchive a workflow

post

Restores an archived workflow.

Requires API key scope workflow:delete.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Responses

200

Unarchived workflow

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Workflow 1

descriptionstringOptional

Description of the workflow

Example: My workflow description

activebooleanRead-onlyOptional

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

isArchivedbooleanRead-onlyOptional

versionIdstringRead-onlyOptional

Current version identifier used for optimistic locking

triggerCountintegerRead-onlyOptional

Number of active trigger nodes in the workflow

connectionsobjectRequiredExample: {"Jira":{"main":[[{"node":"Jira","type":"main","index":0}]]}}

staticDataany ofOptionalExample: {"lastId":1}

string · jsonString · nullableOptional

or

object · nullableOptional

pinDataobject · nullableOptional

Pinned sample data for nodes, keyed by node name

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

post/workflows/{id}/unarchive

HTTPcURLJavaScriptPython

POST /api/v1/workflows/{id}/unarchive HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "2tUt1wbLX592XDdX",
  "name": "Workflow 1",
  "description": "My workflow description",
  "active": true,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z",
  "isArchived": true,
  "versionId": "text",
  "triggerCount": 1,
  "nodes": [
    {
      "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
      "name": "Jira",
      "webhookId": "text",
      "disabled": true,
      "notesInFlow": true,
      "notes": "text",
      "type": "n8n-nodes-base.jira",
      "typeVersion": 1,
      "executeOnce": false,
      "alwaysOutputData": false,
      "retryOnFail": false,
      "maxTries": 1,
      "waitBetweenTries": 1,
      "onError": "stopWorkflow",
      "position": [
        -100,
        80
      ],
      "parameters": {
        "additionalProperties": {}
      },
      "credentials": {
        "jiraSoftwareCloudApi": {
          "id": "35",
          "name": "jiraApi"
        }
      },
      "customTelemetryTags": {
        "tag": [
          {
            "key": "text",
            "value": "text"
          }
        ]
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "connections": {
    "Jira": {
      "main": [
        [
          {
            "node": "Jira",
            "type": "main",
            "index": 0
          }
        ]
      ]
    }
  },
  "nodeGroups": [
    {
      "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
      "name": "Data processing",
      "nodeIds": [
        "text"
      ]
    }
  ],
  "settings": {
    "saveExecutionProgress": true,
    "saveManualExecutions": true,
    "saveDataErrorExecution": "all",
    "saveDataSuccessExecution": "all",
    "executionTimeout": 3600,
    "errorWorkflow": "VzqKEW0ShTXA5vPj",
    "timezone": "America/New_York",
    "executionOrder": "v1",
    "callerPolicy": "workflowsFromSameOwner",
    "callerIds": "14, 18, 23",
    "timeSavedPerExecution": 1,
    "redactionPolicy": "non-manual",
    "availableInMCP": false,
    "customTelemetryTags": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  },
  "staticData": {
    "lastId": 1
  },
  "pinData": {},
  "meta": {
    "onboardingId": "text",
    "templateId": "text",
    "instanceId": "text",
    "templateCredsSetupCompleted": true
  },
  "tags": [
    {
      "id": "2tUt1wbLX592XDdX",
      "name": "Production",
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "shared": [
    {
      "role": "workflow:owner",
      "workflowId": "2tUt1wbLX592XDdX",
      "projectId": "2tUt1wbLX592XDdX",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      },
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "activeVersion": {
    "versionId": "7c6b9e3f-8d4a-4b2c-9f1e-6a5d3b8c7e4f",
    "workflowId": "2tUt1wbLX592XDdX",
    "nodes": [
      {
        "id": "0f5532f9-36ba-4bef-86c7-30d607400b15",
        "name": "Jira",
        "webhookId": "text",
        "disabled": true,
        "notesInFlow": true,
        "notes": "text",
        "type": "n8n-nodes-base.jira",
        "typeVersion": 1,
        "executeOnce": false,
        "alwaysOutputData": false,
        "retryOnFail": false,
        "maxTries": 1,
        "waitBetweenTries": 1,
        "onError": "stopWorkflow",
        "position": [
          -100,
          80
        ],
        "parameters": {
          "additionalProperties": {}
        },
        "credentials": {
          "jiraSoftwareCloudApi": {
            "id": "35",
            "name": "jiraApi"
          }
        },
        "customTelemetryTags": {
          "tag": [
            {
              "key": "text",
              "value": "text"
            }
          ]
        },
        "createdAt": "2026-07-19T15:34:20.583Z",
        "updatedAt": "2026-07-19T15:34:20.583Z"
      }
    ],
    "connections": {
      "Jira": {
        "main": [
          [
            {
              "node": "Jira",
              "type": "main",
              "index": 0
            }
          ]
        ]
      }
    },
    "nodeGroups": [
      {
        "id": "9b1c8e2a-4d3f-4a6b-8c7d-1e2f3a4b5c6d",
        "name": "Data processing",
        "nodeIds": [
          "text"
        ]
      }
    ],
    "authors": "1,2,3",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
}

Transfer a workflow to another project

put

Transfer a workflow to another project

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Body

application/json

destinationProjectIdstringRequired

The ID of the project to transfer the workflow to.

Responses

200

Operation successful.

No content

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

put/workflows/{id}/transfer

HTTPcURLJavaScriptPython

PUT /api/v1/workflows/{id}/transfer HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "destinationProjectId": "text"
}

No content

Get workflow tags

get

Get workflow tags.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Responses

200

List of tags

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Production

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

get/workflows/{id}/tags

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{id}/tags HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "id": "2tUt1wbLX592XDdX",
    "name": "Production",
    "createdAt": "2026-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
]

Update tags of a workflow

put

Update tags of a workflow.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Bodyobject[]

application/json

idstringRequiredExample: 2tUt1wbLX592XDdX

Responses

200

List of tags after add the tag

application/json

idstringRead-onlyOptionalExample: 2tUt1wbLX592XDdX

namestringRequiredExample: Production

createdAtstring · date-timeRead-onlyOptional

updatedAtstring · date-timeRead-onlyOptional

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

put/workflows/{id}/tags

HTTPcURLJavaScriptPython

PUT /api/v1/workflows/{id}/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-07-19T15:34:20.583Z",
    "updatedAt": "2026-07-19T15:34:20.583Z"
  }
]