How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
28
Base URL
https://your.kiteworks.domain/rest
Resource Areas
1

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
deleteRestFolders 3 params → 204490
POST
/rest/folders/actions/favorite
Set multiple folders as favorite
postRestFoldersActionsFavorite 4 params → 200409490
DELETE
/rest/folders/actions/favorite
Removes specified folders from favorites
deleteRestFoldersActionsFavorite 3 params → 204403490
DELETE
/rest/folders/actions/permanent
Permanently delete the specified folders
deleteRestFoldersActionsPermanent 3 params → 204490
PATCH
/rest/folders/actions/recover
Recover deleted folders
patchRestFoldersActionsRecover 4 params → 200490
POST
/rest/folders/actions/scan
Triggers on demand AV/DLP scan on multiple folders
postRestFoldersActionsScan 4 params → 200490
GET
/rest/folders/shared
List top level shared folders
getRestFoldersShared 33 params → 200490
POST
/rest/folders/{id}/actions/move
Move a folder
postRestFoldersByIdActionsMove 4 params body → 201401403409413422490
DELETE
/rest/folders/{id}/actions/permanent
Permanently delete the specified folder
deleteRestFoldersByIdActionsPermanent 1 param → 204490
PATCH
/rest/folders/{id}/actions/recover
Recover deleted folder
patchRestFoldersByIdActionsRecover 3 params → 200490
POST
/rest/folders/{id}/actions/scan
Triggers on demand AV/DLP folder scan
postRestFoldersByIdActionsScan 6 params → 200403490
POST
/rest/folders/{id}/actions/sendMessage
Send message from a folder
postRestFoldersByIdActionsSendMessage 1 param body → 201401403422490
GET
/rest/folders/{id}/comments
List comments for the folder
getRestFoldersByIdComments 21 params → 200490
GET
/rest/folders/{id}/folders
List children folders of specified parent
getRestFoldersByIdFolders 34 params → 200403490
POST
/rest/folders/{id}/folders
Create a folder
postRestFoldersByIdFolders 4 params body → 201401403409490
POST
/rest/folders/{id}/members
Add members to a folder
postRestFoldersByIdMembers 7 params body → 201207401403409490
GET
/rest/folders/{id}/members
List folder members
getRestFoldersByIdMembers 14 params → 200400401403422490
GET
/rest/folders/{id}/members/ldapGroup
List LDAP groups with access to a folder
getRestFoldersByIdMembersLdapGroup 10 params → 200490
GET
/rest/folders/{id}/members/ldapGroup/{ldap_group_id}
Return a specific LDAP group's access to a folder
getRestFoldersByIdMembersLdapGroupByLdapGroupId 4 params → 200490
PUT
/rest/folders/{id}/members/ldapGroup/{ldap_group_id}
Update folder LDAP group members
putRestFoldersByIdMembersLdapGroupByLdapGroupId 5 params body → 200403422490
DELETE
/rest/folders/{id}/members/ldapGroup/{ldap_group_id}
Delete a folder LDAP group member
deleteRestFoldersByIdMembersLdapGroupByLdapGroupId 3 params → 204401403422490
GET
/rest/folders/{id}/members/{member_user_id}
Return folder user member
getRestFoldersByIdMembersByMemberUserId 4 params → 200490
PUT
/rest/folders/{id}/members/{member_user_id}
Update folder user members
putRestFoldersByIdMembersByMemberUserId 5 params body → 200403422490
DELETE
/rest/folders/{id}/members/{member_user_id}
Delete a folder member
deleteRestFoldersByIdMembersByMemberUserId 3 params → 204401403422490
GET
/rest/folders/{id}/tasks
Get tasks for a folder
getRestFoldersByIdTasks 30 params → 200490
GET
/rest/folders/{id}/tree
Get the ancestor path of a folder
getRestFoldersByIdTree 3 params → 200403490
GET
/rest/folders/{parent}/files
Return the list of files in a folder
getRestFoldersByParentFiles 27 params → 200400401422490
GET
/rest/permissions/folder/{id}
List folder permissions
getRestPermissionsFolderById 7 params → 200400401422490
POST
/rest/folders/actions/move
Move multiple folders
postRestFoldersActionsMove 3 params body → 201207403490
GET
/rest/folders/{id}/quota
Return the folder quota
getRestFoldersByIdQuota 2 params → 200401403490
GET
/rest/folders/{id}/children
List folder children
getRestFoldersByIdChildren 12 params → 200400401422490
GET
/rest/folders/top
List top level folders
getRestFoldersTop 6 params → 200400401422490
PUT
/rest/folders/{id}
Update a folder
putRestFoldersById 4 params body → 200401403409490
GET
/rest/folders/{id}
Return the folder
getRestFoldersById 4 params → 200400401403490
DELETE
/rest/folders/{id}
Delete a folder
deleteRestFoldersById 1 param → 204401403490
GET
/rest/folders/{id}/activities
Return folder activities
getRestFoldersByIdActivities 17 params → 200401422490
GET
/rest/folders/{id}/activities/actions/exportCSV
Export folder activities
getRestFoldersByIdActivitiesActionsExportCSV 17 params → 200401422490
DELETE
/rest/folders/{id}/members/me
Remove oneself as a folder member
deleteRestFoldersByIdMembersMe 2 params → 204401403422490
PUT
/rest/admin/folders
Bulk update folders
putRestAdminFolders 3 params body → 200401403422490

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.

UserBasic
object
4 properties
Member
object
14 properties
Error
object
2 properties
DrmFile
object
2 properties
Package
object
9 properties
Errors
object
1 property
Recipient
object
5 properties
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 required
Folder
object
43 properties
MobileInfo
object
5 properties
MemberGroup
object
Class MemberGroup
9 properties 3 required
Attachment
object
19 properties
Comment
object
Class Comment
15 properties 5 required
MemberGroup.Put
object
Class MemberGroup
3 properties 1 required
EmailReturnRecipient
object
2 properties
SafeEdit
object
2 properties
ErrorStringSchemaAccessVerifications
object
6 properties
Folders
object
2 properties
UserMetadata
object
Class UserMetadata
2 properties
ActivityList
object
1 property
Mail
object
45 properties
FolderCreatePostRequest
object
14 properties 1 required
FolderTreeItem
object
Represents a single node in a folder's ancestor chain, from root down to the target folder.
2 properties
LdapGroup
object
Class LdapGroup
5 properties 2 required
AccessVerificationApproval
object
20 properties
Tag
object
3 properties
MultipleFolderIdRequest
object
2 properties 2 required
BaseObject
object
Class Object
17 properties 4 required
FolderFileAddMembers
object
3 properties
TrackingAccessRecipient
object
6 properties
Fingerprint
object
2 properties
Folder1
object
44 properties
AdminFolderPutRequest
object
5 properties 1 required
Activity
object
9 properties
RiskPolicy
object
20 properties
FolderPermissions
object
1 property
Role
object
4 properties
ErrorString
object
4 properties
Favorite
object
Class Favorite
6 properties 3 required
Requirement
object
22 properties
File
object
46 properties
Task
object
Class Task
17 properties 6 required
FolderQuota
object
6 properties
FolderSendMessageRequest
object
6 properties 1 required
Members
object
2 properties
FoldersMetaData
object
5 properties
BulkOperationMoveFolders
object
3 properties
Member.Put
object
Class Member
4 properties 1 required
FolderUpdatePutRequest
object
14 properties
User
object
Class User
22 properties 6 required
FolderChildrenFiles
object
2 properties
ActivityUser
object
4 properties
Variables
object
2 properties
PushedObject
object
4 properties
FolderMemberPostRequest
object
6 properties 1 required
DestinationFolderIdRequest
object
2 properties 1 required
Group
object
5 properties
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-folders-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks Activities API
Kiteworks Admin API
Kiteworks Advanced Forms API
Kiteworks Cards API
Kiteworks Client Event Logs API
Kiteworks Clients API
Kiteworks Comments API
Kiteworks Contacts API
Kiteworks Devices API
Kiteworks Dli API
Kiteworks External DL API
Kiteworks Favorites API
Where this information came from

This is an independent, third-party profile of Kiteworks Folders API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.