Kiteworks folders API
The folders API from Kiteworks — 30 operation(s) for folders.
Kiteworks folders API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include folders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 39 operations across 30 paths, and defines 59 schemas. It is described by OpenAPI 3.0.2, at version 28.
Requests are made against the base URL https://your.kiteworks.domain/rest.
39 operations
30 paths
59 schemas
8 DELETE17 GET2 PATCH8 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 39
Across 30 paths, the API surfaces 39 operations — 8 DELETE, 17 GET, 2 PATCH, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
folders 39
DELETE
/rest/folders
Delete a list of folders
POST
/rest/folders/actions/favorite
Set multiple folders as favorite
DELETE
/rest/folders/actions/favorite
Removes specified folders from favorites
DELETE
/rest/folders/actions/permanent
Permanently delete the specified folders
PATCH
/rest/folders/actions/recover
Recover deleted folders
POST
/rest/folders/actions/scan
Triggers on demand AV/DLP scan on multiple folders
GET
/rest/folders/shared
List top level shared folders
POST
/rest/folders/{id}/actions/move
Move a folder
DELETE
/rest/folders/{id}/actions/permanent
Permanently delete the specified folder
PATCH
/rest/folders/{id}/actions/recover
Recover deleted folder
POST
/rest/folders/{id}/actions/scan
Triggers on demand AV/DLP folder scan
POST
/rest/folders/{id}/actions/sendMessage
Send message from a folder
GET
/rest/folders/{id}/comments
List comments for the folder
GET
/rest/folders/{id}/folders
List children folders of specified parent
POST
/rest/folders/{id}/folders
Create a folder
POST
/rest/folders/{id}/members
Add members to a folder
GET
/rest/folders/{id}/members
List folder members.
GET
/rest/folders/{id}/members/ldapGroup
List LDAP groups with access to a folder
GET
/rest/folders/{id}/members/ldapGroup/{ldap_group_id}
Return a specific LDAP group's access to a folder
PUT
/rest/folders/{id}/members/ldapGroup/{ldap_group_id}
Update folder LDAP group members
DELETE
/rest/folders/{id}/members/ldapGroup/{ldap_group_id}
Delete a folder LDAP group member
GET
/rest/folders/{id}/members/{member_user_id}
Return folder user member
PUT
/rest/folders/{id}/members/{member_user_id}
Update folder user members
DELETE
/rest/folders/{id}/members/{member_user_id}
Delete a folder member
GET
/rest/folders/{id}/tasks
Get tasks for a folder
GET
/rest/folders/{id}/tree
Get the ancestor path of a folder
GET
/rest/folders/{parent}/files
Return the list of files in a folder
GET
/rest/permissions/folder/{id}
List folder permissions
POST
/rest/folders/actions/move
Move multiple folders
GET
/rest/folders/{id}/quota
Return the folder quota
GET
/rest/folders/{id}/children
List folder children
GET
/rest/folders/top
List top level folders
PUT
/rest/folders/{id}
Update a folder
GET
/rest/folders/{id}
Return the folder
DELETE
/rest/folders/{id}
Delete a folder
GET
/rest/folders/{id}/activities
Return folder activities
GET
/rest/folders/{id}/activities/actions/exportCSV
Export folder activities
DELETE
/rest/folders/{id}/members/me
Remove oneself as a folder member
PUT
/rest/admin/folders
Bulk update folders
Schemas 59
The contract defines 59 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Mail (45 properties), Folder1 (44 properties), Folder (43 properties). Each schema is shown below with its type and property counts.
BulkOperationMoveFolders
object
3 properties
Requirement
object
22 properties
Errors
object
1 property
FolderFileAddMembers
object
3 properties
PushedObject
object
4 properties
Tag
object
3 properties
TrackingAccessRecipient
object
6 properties
Member.Put
object
Class Member
4 properties
1 required
MemberGroup.Put
object
Class MemberGroup
3 properties
1 required
Folder1
object
44 properties
MetaData
object
3 properties
UserBasic
object
4 properties
Attachment
object
19 properties
FolderPermissions
object
1 property
UserMetadata
object
Class UserMetadata
2 properties
Task
object
Class Task
17 properties
6 required
Mail
object
45 properties
Recipient
object
5 properties
FolderChildrenFiles
object
2 properties
FolderUpdatePutRequest
object
14 properties
ErrorStringSchemaAccessVerifications
object
6 properties
FolderSendMessageRequest
object
6 properties
1 required
DestinationFolderIdRequest
object
2 properties
1 required
Members
object
2 properties
Permission
object
3 properties
UserBasicInfo
object
4 properties
3 required
Favorite
object
Class Favorite
6 properties
3 required
Folder
object
43 properties
Error
object
2 properties
ActivityUser
object
4 properties
MemberGroup
object
Class MemberGroup
9 properties
3 required
Role
object
4 properties
File
object
46 properties
DrmFile
object
2 properties
FolderMemberPostRequest
object
6 properties
1 required
LdapGroup
object
Class LdapGroup
5 properties
2 required
RiskPolicy
object
20 properties
MobileInfo
object
5 properties
Fingerprint
object
2 properties
FolderQuota
object
6 properties
FoldersMetaData
object
5 properties
User
object
Class User
22 properties
6 required
ErrorString
object
4 properties
ActivityList
object
1 property
MultipleFolderIdRequest
object
2 properties
2 required
EmailReturnRecipient
object
2 properties
Folders
object
2 properties
Member
object
14 properties
FolderTreeItem
object
Represents a single node in a folder's ancestor chain, from root down to the target folder.
2 properties
AdminFolderPutRequest
object
5 properties
1 required
FolderCreatePostRequest
object
14 properties
1 required
SafeEdit
object
2 properties
Package
object
9 properties
Activity
object
9 properties
Variables
object
2 properties
Group
object
5 properties
BaseObject
object
Class Object
17 properties
4 required
AccessVerificationApproval
object
20 properties
Comment
object
Class Comment
15 properties
5 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kiteworks 12
Other APIs Kiteworks publishes across the network.
Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API
#folders