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

Folders

Operations about folders

Retrieve folders

get

Retrieve folders within a project. Supports filtering, sorting, field selection, and pagination.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
projectIdstringRequired

The ID of the project.

Query parameters
filterstringOptional

JSON-encoded filter object. Supported fields — parentFolderId, name, tags (array of tag names), excludeFolderIdAndDescendants.

Example: {"parentFolderId":"abc123","name":"My Folder"}
selectstringOptional

JSON-encoded array of fields to include. Valid fields — id, name, createdAt, updatedAt, project, tags, parentFolder, workflowCount, subFolderCount, path.

Example: ["id","name","tags","workflowCount"]
sortBystring · enumOptional

Sort order for results.

Possible values:
skipstringOptional

Number of items to skip for pagination. Defaults to 0.

takestringOptional

Number of items to return. Defaults to 10.

Responses
200

Operation successful.

application/json
countintegerOptional

Total number of folders matching the query.

get/projects/{projectId}/folders

Create a folder

post

Create a folder within a project.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
projectIdstringRequired

The ID of the project.

Body
namestringRequiredExample: My Folder
parentFolderIdstringOptionalExample: abc123
Responses
201

Operation successful.

application/json
idstringRead-onlyOptional
namestringOptionalExample: My Folder
parentFolderIdstring · nullableOptional
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
post/projects/{projectId}/folders

Get folder details

get

Get folder details including sub-folder and workflow counts.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
projectIdstringRequired

The ID of the project.

folderIdstringRequired

The ID of the folder.

Responses
200

Operation successful.

application/json
idstringRead-onlyOptional
namestringOptional
parentFolderIdstring · nullableOptional
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
totalSubFoldersintegerOptional

Total number of sub-folders (recursive).

totalWorkflowsintegerOptional

Total number of workflows (recursive).

get/projects/{projectId}/folders/{folderId}

Delete a folder

delete

Delete a folder within a project. When transferToFolderId is provided, workflows and sub-folders are moved to the target folder before deletion. When omitted, workflows are moved to the project root and archived, and child folders are deleted.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
projectIdstringRequired

The ID of the project.

folderIdstringRequired

The ID of the folder.

Query parameters
transferToFolderIdstringOptional

Optional target folder ID to move workflows and sub-folders into before deleting.

Responses
204

Operation successful.

No content

delete/projects/{projectId}/folders/{folderId}

No content

Update a folder

patch

Update folder name or parent folder.

Authorizations
X-N8N-API-KEYstringRequired
Path parameters
projectIdstringRequired

The ID of the project.

folderIdstringRequired

The ID of the folder.

Body
namestringOptionalExample: Renamed Folder
parentFolderIdstringOptionalExample: abc123
Responses
200

Operation successful.

application/json
idstringRead-onlyOptional
namestringOptionalExample: My Folder
parentFolderIdstring · nullableOptional
createdAtstring · date-timeRead-onlyOptional
updatedAtstring · date-timeRead-onlyOptional
patch/projects/{projectId}/folders/{folderId}

Last updated

Was this helpful?