Folder API

Create new folder

POST /folder (Create new folder)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
project	required	string	Project ID
name	required	string	Folder name
parent	optional	string	Parent folder ID
users	optional	array	Array of user IDs to share

Responses

http code	content-type	response
200	application/json	{ err: false, data: Folder }
403	application/json	No project permission access

Example

POST /folder
{
  "project": "614aa2a260318c20a6fed424",
  "name": "My Folder",
  "parent": "614aa2a260318c20a6fed425",
  "shared": ["userId1", "userId2"]
}

Get folder list

GET /folder (Get folder list)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Query

name	type	data type	description
project	required	string	Project ID
flat	optional	boolean	If true, returns flat folder structure

Responses

http code	content-type	response
200	application/json	{ err: false, data: Array of Folders }
403	application/json	No project permission access

Example

GET /folder?project=614aa2a260318c20a6fed424&flat=true

Get single folder

GET /folder/:id (Get single folder)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Folder ID

Responses

http code	content-type	response
200	application/json	{ err: false, data: Folder }
403	application/json	Folder not found or access denied

Example

GET /folder/614aa2a260318c20a6fed425

Edit folder name

PUT /folder/:id/name (Edit folder name)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Folder ID
name	required	string	New folder name

Responses

http code	content-type	response
200	application/json	{ err: false, data: Folder }
403	application/json	Folder not found or access denied

Example

PUT /folder/614aa2a260318c20a6fed425/name
{
  "name": "New Folder Name"
}

Edit folder permissions

PUT /folder/:id/permissions (Edit folder permissions)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Folder ID
users	required	array	Array of user IDs

Responses

http code	content-type	response
200	application/json	{ err: false, data: Folder }
403	application/json	Folder not found or access denied

Example

PUT /folder/614aa2a260318c20a6fed425/permissions
{
  "users": ["userId1", "userId2", "userId3"]
}

Move folder

PUT /folder/:id/move (Move folder to new parent)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Folder ID to move (in URL)
parentId	required	string	New parent folder ID (null to move to root)
keepPermissions	optional	boolean	If true, keep current permissions, else inherit from parent

Responses

http code	content-type	response
200	application/json	{ err: false, data: Folder }
400	application/json	Cannot move folder to its own descendant
403	application/json	Folder not found or access denied

Example

PUT /folder/614aa2a260318c20a6fed425/move
{
  "parentId": "614aa2a260318c20a6fed426",
  "keepPermissions": false
}

Notes

• When keepPermissions is false (default), the moved folder will inherit permissions from its new parent
• When moving a folder to root level (parentId: null), existing permissions are preserved
• The operation will fail if attempting to move a folder to one of its own descendants
• User must have access to both the folder being moved and the target parent folder
• Moving a folder updates its updateDate field
• Parent-child relationships are automatically maintained in both old and new parent folders

Remove folder

DELETE /folder/:id (Remove empty folder)

Headers

name	type	data type	description
Authorization	required	string	Bearer token

Parameters

name	type	data type	description
id	required	string	Folder ID

Responses

http code	content-type	response
200	application/json	{ err: false, data: Folder }
403	application/json	Folder not found or access denied
400	application/json	Cannot remove folder with children items

Example

DELETE /folder/614aa2a260318c20a6fed425