Delete a list of folders
Deletes multiple folders specified in the request.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
The specified folders were deleted. No content is returned.
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/folders"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())Permanently delete the specified folders
Permanently delete the specified folders.
These folders will no longer be accessible by any means.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
Determines the detail level of the response body.
The specified folders were permanently deleted. No content is returned.
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders/actions/permanent?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/folders/actions/permanent"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.delete(url, params=params, headers=headers)
print(response.json())Recover deleted folders
Recover deleted folders and their children files and folders.
A comma-separated list of unique identifiers for the entities to be processed.. A comma-separated list of unique identifiers for the entities to be processed.
If set to true, the operation will continue for the valid items even if some items result in failure.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the list of recovered folders with their updated metadata.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/folders/actions/recover?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/folders/actions/recover"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.patch(url, params=params, headers=headers)
print(response.json())Triggers on demand AV/DLP scan on multiple folders
Attempts to trigger an AV/DLP scan on requested folders.
If set to true, returns information about the newly created entity.
List of IDs of entities to scan. Search for results that match any of the specified values for this parameter.
With parameters
Determines the detail level of the response body.
Returns the list of folders with their scan status updated to reflect that scans have been triggered.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/actions/scan?id:in=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/folders/actions/scan"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"id:in": "VALUE",
}
response = requests.post(url, params=params, headers=headers)
print(response.json())Move a folder
Description:
Moves the specified folder to a new destination folder.Precondition:
User must have `folder_move` permission for the folder being moved. User must have `folder_add` permission for the destination folder.Response:
The folder is moved to the destination folder.The unique identifier (UUID) of the entity.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The ID of the destination folder where the item will be copied/moved.
If a file with the same name exists, create a new version instead of overwriting it. Default is True.
Folder successfully moved
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_CONTAINS_LOCKED_FILES, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_IS_SYNC_DIR
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Content Too Large
Possible error codes: ERR_SYSTEM_NO_STORAGE_AVAILABLE
Error code
Error message
Unprocessable Content
Possible error codes: ERR_CANNOT_MOVE_FOLDER_TO_SELF, ERR_CANNOT_MOVE_TO_CHILD, ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/move" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"destinationFolderId": "string",
"addVersion": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/move"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"destinationFolderId": "string",
"addVersion": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Permanently delete the specified folder
Permanently delete the specified folder.
This folder will no longer be accessible by any means.
The unique identifier (UUID) of the folder.
The folder was permanently deleted. No content is returned.
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/permanent" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/permanent"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Recover deleted folder
Recover the specified folder. This un-marks the folder for deletion.
The unique identifier (UUID) of the folder.
If set to true, returns information about the newly created entity.
Determines the detail level of the response body.
Returns the recovered folder with its updated metadata.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Request blocked by WAF
curl -X PATCH \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/recover" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/recover"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.patch(url, headers=headers)
print(response.json())Triggers on demand AV/DLP folder scan
Attempts to trigger an AV/DLP scan on requested folder.
The unique identifier (UUID) of the folder.
If set to true, returns information about the newly created entity.
List of folder IDs of entities to scan. Search for results that match any of the specified values for this parameter.
List of file IDs of entities to scan. Search for results that match any of the specified values for this parameter.
With parameters
Determines the detail level of the response body.
Returns the folder with its scan status updated to reflect that a scan has been triggered.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/scan" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/scan"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.post(url, headers=headers)
print(response.json())Send message from a folder
Description:
Sends a message from the specified folder to members of the folder.Precondition:
The user must be a member of the folder.Response:
The message has been successfully sent to members.The unique identifier (UUID) of the entity.
List of recipient user UUIDs (To field).
List of recipient user UUIDs (CC field).
List of recipient user UUIDs (BCC field).
If true, the message body is hidden from the notification email and is only visible to recipients when they open the secure link.
The body content of the email.
The subject of the email (maximum length: 998 characters).
The message has been successfully sent to members.
Unique identifier of the email.
Unique identifier of the sender.
Unique identifier of the email template used.
Current status of the email (e.g., sent, draft, error, etc.).
Type of the email (e.g., original, reply, forward, etc.).
Date the email was last modified or sent.
Indicates if the email has been deleted.
Date when the email was withdrawn, if applicable.
Unique identifier of the associated email package.
Indicates whether the email is a view-only version, typically used for previewing attachments without enabling downloading.
Indicates whether the email was sent by the current user or another user.
Text watermark applied to the email attachments (applicable only for view-only version).
The variable name
The variable value
Unique identifier of the user associated with the recipient.
Recipient type.0 – To.1 – CC.2 – BCC.
Email address of the recipient.
Indicates if the recipient is a distribution list rather than an individual user.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the email body is secured.
Date the email was last modified.
Unique identifier of the parent email, if applicable.
Unique identifier of the user who requested the return receipt.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Error message associated with the email, if any.
Subject line of the email.
Number of attachments in the email.
Expiration date of the email package, if applicable.
Antivirus (AV) scan status of the email.
Data Loss Prevention (DLP) scan status of the email.
Indicates if tracking access is enabled for the email.
Unique identifier of the user associated with the recipient.
Recipient type.0 – To.1 – CC.2 – BCC.
Email address of the recipient.
Indicates if the recipient is a distribution list rather than an individual user.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates whether the recipient's tracking access has been revoked.
Indicates the restriction type applied to the email
Indicates if the email has been read.
The bucket where the email is stored. (e.g. inbox, sent, trash)
The body of the email.
Unique identifier of the email package.
Indicates whether the package includes a copy for the sender.
Indicates whether a fingerprint (hash) of the package should be included for verification.
Expiration time of the package in seconds from creation.
Count of the files attached to the package.
Indicates whether the package has been marked as deleted.
Access control list (ACL) associated with the package, specifying who can access it.
Unique identifier for the email package containing the attachment.
Unique identifier for the attachment.
Indicates whether the attachment has been withdrawn.
Name of the DRM-protected file.
Size of the DRM-protected file in bytes.
Access type for the attachment (e.g., read-only, editable).
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Unique identifier for the file associated with the attachment.
Name of the attachment file.
Size of the attachment file in bytes.
The MIME type of the attachment file.
Date when the attachment file was created.
Indicates if the attachment has been deleted.
A unique hash identifying the file version.
The algorithm used for generating the file version fingerprint. (e.g., sha3-256, md5).
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
Status of the attachment in the admin quarantine system.
Antivirus (AV) scan status of the attachment.
Data Loss Prevention (DLP) status of the attachment.
Link for accessing the email.
Raw email body content without HTML markup.
Headline or main title of the email.
Notice part of the email.
Full HTML body of the email.
The email address from which the email was sent.
Body content generated from the email template.
Unique identifier of the web form associated with the email.
Fields included in the associated web form with the mail.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier of the shared mailbox, if applicable.
HTML version of the email body.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
CSS styles applied for dark mode.
Indicates whether the email already exists in the system.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/actions/sendMessage" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"to": [
"string"
],
"cc": [
"string"
],
"bcc": [
"string"
],
"secureBody": true,
"body": "string",
"subject": "string"
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/actions/sendMessage"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"to": [
"string"
],
"cc": [
"string"
],
"bcc": [
"string"
],
"secureBody": true,
"body": "string",
"subject": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())List children folders of specified parent
Return the list of folders in the specified folder including its metadata.
ID of the parent folder
Folder name
Folder name. Search for results that contain the specified characters in this parameter.
Unique identifier of Object creator
Unique identifier of Object creator. Search for results that match any of the specified values for this parameter.
Object creation date
Object creation date. Search for results where this parameter value is greater than the specified value.
Object creation date. Search for results where this parameter value is greater than or equal to the specified value.
Object creation date. Search for results where this parameter value is less than the specified value.
Object creation date. Search for results where this parameter value is less than or equal to the specified value.
Object modification date
Object modification date. Search for results where this parameter value is greater than the specified value.
Object modification date. Search for results where this parameter value is greater than or equal to the specified value.
Object modification date. Search for results where this parameter value is less than the specified value.
Object modification date. Search for results where this parameter value is less than or equal to the specified value.
Indicates whether the object is deleted.
Expiration date
Expiration date. Search for results where this parameter value is greater than the specified value.
Expiration date. Search for results where this parameter value is greater than or equal to the specified value.
Expiration date. Search for results where this parameter value is less than the specified value.
Expiration date. Search for results where this parameter value is less than or equal to the specified value.
Folder lifetime
Folder lifetime. Search for results where this parameter value is greater than the specified value.
Folder lifetime. Search for results where this parameter value is greater than or equal to the specified value.
Folder lifetime. Search for results where this parameter value is less than the specified value.
Folder lifetime. Search for results where this parameter value is less than or equal to the specified value.
Folder secure flag
Folder description. Search for results that contain the specified characters in this parameter.
Sorting options
Offset
Limit
If specified, "offset" parameter will be ignored
and the page containing entity with this Id will be returned.
With parameters
Determines the detail level of the response body.
Returns a paginated list of child folders within the specified parent folder, including each folder's metadata.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Forbidden
Possible error codes: ERR_ACCESS_DLI_ADMIN
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/folders" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # ID of the parent folder
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/folders"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Create a folder
Description:
Creates a new folder under the specified parent folder.Precondition:
User must have `folder_add` permission for the parent folder.Response:
The new folder is created and its details are returned.The unique identifier (UUID) of the entity.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The name of the new folder (maximum 255 characters).
Marks the folder as secure, restricting access to authorised recipients only. Can only be set on top-level folders under the user's root folder.
Indicates whether the folder can be synced by the Desktop Sync Client. Can only be set on top-level folders.
The folder expiration date. Applicable to top-level folders only.
Number of days files are retained in this folder before expiring. Set to 0 for no expiration. Applicable to top-level folders.
If true, automatically renames the folder if a folder with the same name already exists in the destination.
Optional description for the folder.
Client application identifier used to associate the folder with a specific plugin or integration.
External vendor document ID to link this folder to a document in a third-party system.
Display name of the linked vendor document.
Indicates whether this folder is being created as part of a folder upload operation. For internal use only.
Indicates whether this is a system folder with its own dedicated storage quota.
Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited.
Indicates whether the folder inherits member permissions from its parent folder.
Folder created successfully.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/folders" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"secure": true,
"syncable": true,
"expire": "2024-01-15",
"fileLifetime": 1,
"rename": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/folders"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"name": "string",
"secure": true,
"syncable": true,
"expire": "2024-01-15",
"fileLifetime": 1,
"rename": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())List folder members.
Description:
Returns a paginated list of members who have access to the specified folder.Precondition:
User must have `user_view` permission for the folder.Response:
A list of folder members is returned.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| id | The member ID |
| userId | The user ID |
| groupId | The group ID |
| roleId | The role ID |
| rank | The rank of the role |
| The member's email |
The unique identifier (UUID) of the entity.
Filter results by email address.
Filter results by user ID.
Filter results by group ID.
Filter results by role ID.
Filter by a comma-separated list of user IDs. (Recommended request size <= 100)
Filter by a comma-separated list of LDAP Group IDs. (Recommended request size <= 100)
Filter by a comma-separated list of role IDs.
Filter members by the object type they have access to.d – Directory (folder) membership.f – File membership.
Sort order for the results. Default is id:asc.
Allowed values: id:asc, id:desc, userId:asc, userId:desc, groupId:asc, groupId:desc, roleId:asc, roleId:desc, rank:asc, rank:desc, email:asc, email:desc.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The folder members have been successfully returned.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_USER, ERR_ACCESS_DENIED, ERR_ENTITY_DELETED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_LICENSE_EXPIRED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/members" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Add members to a folder
Description:
Adds one or more users or LDAP groups as members of the specified folder.Precondition:
User must have `user_add` permission for the folder.Response:
The new members are added to the folder.The unique identifier (UUID) of the entity.
If set to true, updates the member if they already exist and have a different folder role.
If set to true, the operation will continue for the valid items even if some items result in failure.
If set to true, demote the user member role in all applicable nested folders.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
If set to true, notifies the user being invited to the folder via email.
List of email addresses for new members.
List of user IDs for new members.
List of LDAP group IDs for new members.
The role ID to assign to the new members.
If set to true, subscribes the user to notifications for file additions.
Members were added successfully.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
Access Verification ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Requirement ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
List of approvers for the requirement
Asset class associated with the requirement
List of succeeded recipient emails.
Reference ID for the error
List of succeeded IDs.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Some members were added successfully, while others failed.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
Access Verification ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Requirement ID
Unique identifier of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the object.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the object in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
List of approvers for the requirement
Asset class associated with the requirement
List of succeeded recipient emails.
Reference ID for the error
List of succeeded IDs.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ACCESS_USER, ERR_LICENSE_MAX_USERS_COUNT_REACHED, ERR_USER_HAS_NO_USER_TYPE, ERR_USER_TYPE_NO_ACCESS, ERR_INPUT_EMAIL_IS_DISTRIBUTION_LIST, ERR_ENTITY_USER_HAS_INSUFFICIENT_PERMISSIONS, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_IS_OWNER, ERR_ENTITY_DELETED, ERR_CLIENT_OBJECT, ERR_PROFILE_SALESFORCE_OBJECT_DISABLED, ERR_PROFILE_SALESFORCE_OBJECT_ROLE_DISALLOWED
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS, ERR_ENTITY_ROLE_IS_ASSIGNED, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/:id/members" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"notify": true,
"emails": [
"string"
],
"userIds": [
"string"
],
"ldapGroupIds": [
1
],
"roleId": 1,
"notifyFileAdded": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"notify": true,
"emails": [
"string"
],
"userIds": [
"string"
],
"ldapGroupIds": [
1
],
"roleId": 1,
"notifyFileAdded": true
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())List LDAP groups with access to a folder
Returns a list of LDAP groups and their assigned roles for the specified folder.
The unique identifier (UUID) of the folder.
The unique identifier of the group.
The unique identifier of the group.. Search for results that match any of the specified values for this parameter.
The unique identifier of the role.
The unique identifier of the role.. Search for results that match any of the specified values for this parameter.
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
Returns a paginated list of LDAP groups that have been granted access to the specified folder, including each group's assigned role.
Unique identifier of the folder this member belongs to
Unique identifier of the role assigned to this member
LDAP group unique identifier
Display name of the LDAP group
LDAP group email address
LDAP group description
HATEOAS links associated with the entity
Role ID
Role name
Role rank
Role type
Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in "with" parameter)
List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Unique identifier of the LDAP group assigned as a member
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return a specific LDAP group's access to a folder
Returns the access grant record for the specified LDAP group in the folder, including the group's assigned role.
The unique identifier (UUID) of the folder.
The unique identifier of the LDAP group member
With parameters
Determines the detail level of the response body.
Returns the access grant record for the specified LDAP group, including its assigned role in the folder.
Unique identifier of the folder this member belongs to
Unique identifier of the role assigned to this member
LDAP group unique identifier
Display name of the LDAP group
LDAP group email address
LDAP group description
HATEOAS links associated with the entity
Role ID
Role name
Role rank
Role type
Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in "with" parameter)
List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Unique identifier of the LDAP group assigned as a member
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup/:ldap_group_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
ldap_group_id = "VALUE" # The unique identifier of the LDAP group member
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup/{ldap_group_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update folder LDAP group members
Updates LDAP group members within the folder
The unique identifier (UUID) of the folder.
The unique identifier (UUID) of the LDAP group member.
If set to true, returns information about the newly created entity.
Also downgrade the member role for nested folders.
Determines the detail level of the response body.
Unique identifier of the role to assign to this member
Indicates whether the member should be notified when a file is added
Indicates whether HATEOAS links should be included in the response
Returns the updated LDAP group access records reflecting the new role assignment.
Unique identifier of the folder this member belongs to
Unique identifier of the role assigned to this member
LDAP group unique identifier
Display name of the LDAP group
LDAP group email address
LDAP group description
HATEOAS links associated with the entity
Role ID
Role name
Role rank
Role type
Unique identifier of the role inherited from the parent folder (Explicit field. May be retrieved only if mentioned in "with" parameter)
List of role identifiers that are permitted for this folder membership (Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Unique identifier of the LDAP group assigned as a member
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup/:ldap_group_id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"roleId": 1,
"notifyFileAdded": true,
"addLinks": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
ldap_group_id = "VALUE" # The unique identifier (UUID) of the LDAP group member.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup/{ldap_group_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"roleId": 1,
"notifyFileAdded": true,
"addLinks": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete a folder LDAP group member
Description:
Removes an LDAP member from the specified folder.Precondition:
The user must have the `user_remove` permission for the folder.Response:
The specified folder LDAP group member is successfully removed.The unique identifier (UUID) of the entity.
The unique identifier of the LDAP group.
If set to true, the user's role will be removed from all nested folders.
The folder LDAP group member was successfully removed from the folder.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders/:id/members/ldapGroup/:ldap_group_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
ldap_group_id = "VALUE" # The unique identifier of the LDAP group.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/ldapGroup/{ldap_group_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Return folder user member
Returns the specified user member within the folder.
The unique identifier (UUID) of the folder.
The unique identifier (UUID) of the user member.
With parameters
Determines the detail level of the response body.
Returns the specified user member and their role within the folder.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/members/:member_user_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
member_user_id = "VALUE" # The unique identifier (UUID) of the user member.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/{member_user_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update folder user members
Updates the user members within the folder.
The unique identifier (UUID) of the folder.
The unique identifier of the user member.
If set to true, returns information about the newly created entity.
Also downgrade the member role for nested folders.
Determines the detail level of the response body.
Unique identifier of the role to assign to this member
Indicates whether the member should be notified when a file is added
Indicates whether HATEOAS links should be included in the response
Indicates whether user would like to receive emails when new member is added into folder
Returns the updated member records reflecting the new role assignment.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Forbidden
Possible error codes: ERR_ACCESS_USER
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_REQUIRED, ERR_INPUT_INVALID_EMAIL
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/folders/:id/members/:member_user_id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"roleId": 1,
"notifyFileAdded": true,
"addLinks": true,
"notify": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
member_user_id = "VALUE" # The unique identifier of the user member.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/{member_user_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"roleId": 1,
"notifyFileAdded": true,
"addLinks": true,
"notify": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete a folder member
Description:
Removes a member from the specified folder.Precondition:
The user must have the `user_remove` permission for the folder.Response:
The specified folder member is successfully removed.The unique identifier (UUID) of the entity.
The unique identifier (UUID) of the user.
If set to true, the user's role will be removed from all nested folders.
The folder member was successfully removed from the folder.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS, ERR_ENTITY_INHERITED_MEMBER_NOT_MODIFIABLE
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders/:id/members/:member_user_id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
member_user_id = "VALUE" # The unique identifier (UUID) of the user.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/{member_user_id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Get tasks for a folder
Gets a list of tasks associated with all files in the specified folder. Requires task_view permission on the folder.
The unique identifier (UUID) of the folder.
Assigned User unique identifier
Assigned User unique identifier. Search for results that match any of the specified values for this parameter.
Task due date
Task due date. Search for results where this parameter value is greater than the specified value.
Task due date. Search for results where this parameter value is greater than or equal to the specified value.
Task due date. Search for results where this parameter value is less than the specified value.
Task due date. Search for results where this parameter value is less than or equal to the specified value.
Parent Comment identifier
Parent Comment identifier. Search for results that match any of the specified values for this parameter.
Identifier of User who created a Task
Identifier of User who created a Task. Search for results that match any of the specified values for this parameter.
Task creation date
Task creation date. Search for results where this parameter value is greater than the specified value.
Task creation date. Search for results where this parameter value is greater than or equal to the specified value.
Task creation date. Search for results where this parameter value is less than the specified value.
Task creation date. Search for results where this parameter value is less than or equal to the specified value.
Task modification date
Task modification date. Search for results where this parameter value is greater than the specified value.
Task modification date. Search for results where this parameter value is greater than or equal to the specified value.
Task modification date. Search for results where this parameter value is less than the specified value.
Task modification date. Search for results where this parameter value is less than or equal to the specified value.
Task content. Search for results that contain the specified characters in this parameter.
Filter tasks by status. Accepted values: D, P, C.
Whether the task has been deleted
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
Returns a paginated list of tasks for all files within the specified folder.
Task unique identifier
Assigned User unique identifier
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Date and time by which the task must be completed
Parent Comment identifier
Object identifier Task belongs to
Identifier of User who created a Task
The unique identifier of the user
The unique identifier of the user's root Kiteworks directory.
Date and time the user account was created
The user's email
The unique identifier of the user's mydir system directory.
The name of the user
The unique identifier of the user's 'My Folder'.
The unique identifier of the user type (profile).
Indicates whether the user is an internal user
URL to the user's profile icon image
Indicates whether the user is an External Distribution List
Key name of the custom metadata attribute associated with the user
Value assigned to the custom metadata attribute for the user
The ID of the admin role assigned to the user.
HATEOAS links associated with the entity
Indicates whether the user is an actual kitework user
Indicates whether the user is suspended
Indicates whether the user has been deleted
Authentication type.
- 0: No authentication,
- 1: Authentication by kiteworks,
- 2: Authentication by LDAP,
- 4: Authentication by SSO
Indicates whether the user is verified
Indicates whether the user has been deactivated
User's last activity datetime
The exact timestamp when the user's password will expire
Date and time the task was created
Date and time the task was last modified
Body text of the task
Indicates whether the task is deleted
Identifier of Object's parent Folder
Task status. Accepted values: D (Defined), P (In Progress), C (Completed)
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Details of the user who created the object.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
List of permissions associated with the object.
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
List of members who have access to the object.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
The role of the current user in this folder.
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Details of the user who pushed the object.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
The user responsible for locking the file via SafeEdit.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
HATEOAS links associated with the entity
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/tasks" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/tasks"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Get the ancestor path of a folder
Returns the ancestor path of the specified folder as an ordered list of folder nodes, from the root down to the target folder.
The unique identifier (UUID) of the folder.
Include owner root folder in the tree
Determines the detail level of the response body.
Returns an ordered list of ancestor folder nodes from root to the specified folder, representing its full tree path.
The unique identifier of the folder node.
The display name of the folder node.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Forbidden
Possible error codes: ERR_ACCESS_DLI_ADMIN
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/tree" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/tree"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return the list of files in a folder
Description:
Returns the list of files within the specified folder.Precondition:
User must have `properties_view` permission for the folder.Response:
Returns a list of files within the specified folder.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| name | The name of the file |
| created | The creation datetime of file |
| modified | The last modified datetime of file |
| size | The file size (for files) |
The unique identifier (UUID) of the parent folder.
Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.
Filter by the name of file within the folder.
Search for files whose names contain the specified characters.
The unique identifier of the file creator.
Search for files created by the specified user IDs. (Recommended request size <= 100)
Search for files created on the specified date.
Search for files created after the specified date.
Search for files created on or after the specified date.
Search for files created before the specified date.
Search for files created on or before the specified date.
Search for files modified on the specified date.
Search for files modified after the specified date.
Search for files modified on or after the specified date.
Search for files modified before the specified date.
Search for files modified on or before the specified date.
Search for files that expire on the specified date.
Search for files that expire after the specified date.
Search for files that expire on or after the specified date.
Search for files that expire before the specified date.
Search for files that expire on or before the specified date.
If true, returns only files that have been pushed to a mobile device via the mobile sync feature.
Sort order for the results. Default is name:asc.
Allowed values: name:asc, name:desc, created:asc, created:desc, modified:asc, modified:desc, size:asc, size:desc.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
A list of files in the folder is returned successfully.
Unique identifier (UUID) of the file.
Unique identifier (UUID) of the parent folder.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the file.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the file.
Path to the object in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The size of the file in bytes.
The MIME type of the file.
A unique hash identifying the file.
The algorithm used to generate the fingerprint (e.g., sha3-256, md5).
The resulting hash value representing the fingerprint of the file or object.
The date and time when the file was created on the client side.
The date and time when the file was last modified on the client side.
Indicates whether the expiration date for the file has been overridden.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the file was shared.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
The ID of the original file if this one is a copy.
Indicates the file version's availability status based on Antivirus (AV) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on Data Loss Prevention (DLP) settings and whether it has been scanned or detected as infected.
Indicates the file version's availability status based on the administrator's quarantine status.
Indicates if the file is locked.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Indicates if the file is shared with other users.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Unique identifier (UUID) for the pushed object.
Unique identifier (UUID) for the user who pushed the object.
The date and time when the object was pushed.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
A list of IDs representing the path of the file within the folder hierarchy.
The WOPI (Web Application Open Platform Interface) source URL for the mobile application.
Unique identifier of the user.
The WOPI service ID.
URI scheme used by the mobile application to handle the file.
Indicates the level of support the mobile app has for the URI scheme.
Indicates if the file has been pushed to a mobile app.
Unique identifier (UUID) for the tag.
Display name of the tag.
Type category of the tag.
Indicates if the file is locked through a SafeEdit session.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The total number of versions for the file.
Tracking identifier associated with the file upload.
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON
Error code
Error message
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:parent/files" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
parent = "VALUE" # The unique identifier (UUID) of the parent folder.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{parent}/files"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())List folder permissions
Description:
Return the list of permissions associated with the specified folder.Precondition:
The user must be a member of the folder.Response:
Returns a list of available permissions for the specified folder.The unique identifier (UUID) of the entity.
The unique identifier for the action.
List of unique action identifiers. Search for results that match any of the specified values.
Filter by the permission action name.
Allowed values: view, download, comment_view, comment_add, comment_edit, comment_reply, comment_delete, task_view, task_update_status, notification_subscribe, notification_unsubscribe, properties_view, file_send, tray_add, favorite_add.
Action name filter. Search for actions whose names contain the specified characters.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
Successfully returned the list of permissions for the specified folder.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON
Error code
Error message
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/permissions/folder/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/permissions/folder/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Move multiple folders
Description:
Moves multiple folders to a new destination folder.Precondition:
User must have `folder_move` permission for the folders being moved. User must have `folder_add` permission for the destination folder.Response:
The folders are moved to the destination folder.If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
A list of folder IDs to be processed.
The destination folder
Folders successfully moved.
Error code
Error message
Associated field, if applicable.
List of failed IDs.
List of successfully moved folder IDs.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Partially successful operation
Error code
Error message
Associated field, if applicable.
List of failed IDs.
List of successfully moved folder IDs.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Forbidden
Possible error codes: ERR_SYSTEM_FOLDER_QUOTA_EXCEEDED
Error code
Error message
Request blocked by WAF
curl -X POST \
"https://{instance}.kiteworks.com/rest/folders/actions/move" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"folderIds": [
"string"
],
"destinationFolderId": "string"
}'import requests
url = "https://{instance}.kiteworks.com/rest/folders/actions/move"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"folderIds": [
"string"
],
"destinationFolderId": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())Return the folder quota
Description:
Returns the quota information for a specific folder.Precondition:
User must have `file_add` permission for the folder.Response:
The folder quota is returned.The unique identifier (UUID) of the entity.
The unique identifier (UUID) of the file.
The folder quota has been successfully returned.
Quota allowance allocated to the folder in bytes.
Storage available for the folder in bytes.
Total storage quota assigned to the folder in bytes.
Storage currently used by the folder in bytes.
Total size of all files in the folder in bytes.
List of available quota option values (in bytes) for system folders.
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED, ERR_ENTITY_NOT_FOUND
Error code
Error message
Forbidden
Possible error codes: ERR_ENTITY_DELETED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/quota" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/quota"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())List folder children
Description:
Returns the list of folder children, where folders are fetched first, followed by files.Precondition:
User must have `properties_view` permission for the folder.Response:
Returns a list of folders and files within the specified folder.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| name | The name of the folder or file |
| created | The creation datetime of the folder or file |
| modified | The last modified datetime of the folder or file |
| size | The number of items in the folder (for folders) or the file size (for files) |
The unique identifier (UUID) of the entity.
Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.
Sort order for the results. Default is name:asc.
Allowed values: name:asc, name:desc, created:asc, created:desc, modified:asc, modified:desc, size:asc, size:desc.
Filter results by object type.f – Files only.d – Directories (folders) only.
A comma-delimited list of file extensions to include in the filter.
A regular expression pattern used to filter files by their names or other attributes.
Filter by the name of the folder or file within the folder.
Filter by a specific file ID.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
Returns the list of folder children.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON
Error code
Error message
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/children" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/children"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())List top level folders
Description:
Returns the list of top level folders.Precondition:
The user profile must have "Collaboration Allowed" enabled.Response:
Lists of top level folders are returned.Sorting:
Sort string syntax `FIELD_NAME:ORDER`.ORDER can be asc or desc.
Sorting options:
| FIELD_NAME | Description |
|---|---|
| name | The name of the folder |
| created | The creation datetime of the folder |
| modified | The last modified datetime of the folder |
| size | The number of items in the folder |
Filter by deletion status. If true, show only deleted items; if false, show non-deleted items; if not specified, show both deleted and non-deleted items.
Sort order for the results. Default is name:asc.
Allowed values: name:asc, name:desc, created:asc, created:desc, modified:asc, modified:desc, size:asc, size:desc.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The top level folders have been successfully returned.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Total number of deleted folders.
Total number of deleted files.
Bad Request
Possible error codes: ERR_REQUEST_INVALID_JSON
Error code
Error message
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/top" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/folders/top"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Return the folder
Description:
Returns the folder corresponding to the provided ID.Precondition:
User must have `properties_view` permission for the folder.Response:
The folder is returned.The unique identifier (UUID) of the entity.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
The folder has been successfully returned.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Bad Request
Possible error codes: ERR_REQUEST_INVALID_FILTER
Error code
Error message
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ACCESS_DENIED
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Update a folder
Description:
Updates the properties of the specified folder.Precondition:
User must have `properties_edit` permission for the folder.Response:
The folder is updated.The unique identifier (UUID) of the entity.
If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
New name for the folder (maximum 255 characters).
Updated description for the folder.
Indicates whether the folder can be synced by the Desktop Sync Client. Can only be set on top-level folders.
The folder expiration date. Applicable to top-level folders only.
Number of days files are retained in this folder before expiring. Set to 0 for no expiration.
If true, applies the updated fileLifetime setting to all existing files in this folder.
If true, applies the updated fileLifetime setting to all nested subfolders.
Marks the folder as secure, restricting access to authorised recipients only. Can only be set on top-level folders under the user's root folder.
Client application identifier used to associate the folder with a specific plugin or integration.
External vendor document ID to link this folder to a document in a third-party system.
Display name of the linked vendor document.
Indicates whether this is a system folder with its own dedicated storage quota.
Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited.
If true, breaks permission inheritance from the parent folder, making this folder's members independent. Only true is accepted; passing false is invalid.
The folder has been updated successfully.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_DENIED, ERR_ACCESS_USER
Error code
Error message
Conflict
Possible error codes: ERR_ENTITY_EXISTS
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/folders/:id" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"description": "string",
"syncable": true,
"expire": "2024-01-15",
"fileLifetime": 1,
"applyFileLifetimeToFiles": true
}'import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"name": "string",
"description": "string",
"syncable": true,
"expire": "2024-01-15",
"fileLifetime": 1,
"applyFileLifetimeToFiles": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())Delete a folder
Description:
Deletes a specified folder.Precondition:
User must have `folder_delete` permission for the folder.Response:
The folder is deletedAdditional Information:
The folder will be automatically deleted after a set number of days as configured by the administrator.The unique identifier (UUID) of the entity.
The folder has been successfully deleted.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_SYSTEM_TENANT_SUSPENDED, ERR_ACCESS_DENIED, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_NOT_UPDATABLE, ERR_ENTITY_IS_SECURE_FOLDER, ERR_ENTITY_CONTAINS_LOCKED_FILES, ERR_ACCESS_USER, ERR_PROFILE_COLLABORATION_DISABLED, ERR_ENTITY_DELETED
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders/:id" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Return folder activities
Description:
Return the activities of a specified folder.Precondition:
The user must have the `user_view` permission for the folder.Response:
Returns the folder activities.The unique identifier (UUID) of the entity.
Number of days to look back when searching for activities.
Start time of the search range, represented as a Unix timestamp.
End time of the search range, represented as a Unix timestamp.
Start date of the search range.
End date of the search range.
Filter activities by ownership.all – Show all activities in the folder.my – Show only activities performed by the current user.
Search activities by email body, subject, sender, or recipients.
Filter activities by type.all – All activity types.content_changes – File content uploads or replacements.file_changes – File metadata changes (rename, move, delete, etc.).folder_changes – Folder-level changes.kitepoint – KitePoint reward activities.mail – Email send/receive activities.tasks – Task-related activities.comments – Comment activities.folder_activities – General folder activities.
Filter activities by transaction ID.
Sort order for the results. Default is created:desc.
Allowed values: id:asc, id:desc, created:asc, created:desc, event_name:asc, event_name:desc, name:asc, name:desc.
If set to true, includes activities from nested folders.
Specifies a file ID within the folder to filter activities related to that file.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
Successfully return folder activities.
Unique identifier of the activity event.
Date and time when the activity event was recorded.
Name of the activity event.
Human-readable summary of the activity event.
Type category of the activity event.
Indicates whether the activity completed successfully.
Full name of the user.
Email address associated with the user.
URL or identifier for the user's profile icon.
List of permissions required for the activity.
Additional event-specific data associated with the activity.
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/activities" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/activities"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Export folder activities
Description:
Exports the activities of a folder in CSV format.Precondition:
The user must have the `user_view` permission for the folder.Response:
The folder activities are returned in CSV format.The unique identifier (UUID) of the entity.
Number of days to look back when searching for activities.
Start time of the search range, represented as a Unix timestamp.
End time of the search range, represented as a Unix timestamp.
Start date of the search range.
End date of the search range.
Filter activities by ownership.all – Show all activities in the folder.my – Show only activities performed by the current user.
Search activities by email body, subject, sender, or recipients.
Filter activities by type.all – All activity types.content_changes – File content uploads or replacements.file_changes – File metadata changes (rename, move, delete, etc.).folder_changes – Folder-level changes.kitepoint – KitePoint reward activities.mail – Email send/receive activities.tasks – Task-related activities.comments – Comment activities.folder_activities – General folder activities.
Filter activities by transaction ID.
Sort order for the results. Default is created:desc.
Allowed values: id:asc, id:desc, created:asc, created:desc, event_name:asc, event_name:desc, name:asc, name:desc.
If set to true, includes activities from nested folders.
Specifies a file ID within the folder to filter activities related to that file.
Range limit.
Range offset.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
Successfully initiated the folder activities export.
Unauthorized
Possible error codes: ERR_ACCESS_USER, ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/folders/:id/activities/actions/exportCSV" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/activities/actions/exportCSV"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Remove oneself as a folder member
Description:
Removes the current user from the specified folder.Precondition:
The user must be a member of the folder.Response:
The current user is removed from the folder.The unique identifier (UUID) of the entity.
If set to true, the user's role will be removed from all nested folders.
The user was successfully removed from the folder.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_INPUT_IS_OWNER, ERR_ENTITY_PARENT_FOLDER_MEMBER_EXISTS
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INVALID_PARAMETER
Error code
Error message
Request blocked by WAF
curl -X DELETE \
"https://{instance}.kiteworks.com/rest/folders/:id/members/me" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier (UUID) of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/folders/{id}/members/me"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.delete(url, headers=headers)
print(response.json())Bulk update folders
Description:
Updates multiple folders in a single request.Precondition:
The user must be an administrator with access to the Files and Folders page in the Kiteworks PDN Admin.Response:
The specified folders are updated.If true, includes the entity in the response body.
Specifies additional fields to include in the response.
Determines the detail level of the response body.
List of folder object IDs to be updated.
Expiration date for the folder.
Defines the scope of the expiration update.folders – Apply expiration to folders only.files – Apply expiration to files only.folders_and_files – Apply expiration to both folders and files.
Storage quota for the folder in bytes. Must be one of the permitted sizes: 1 GB (1,073,741,824), 2 GB (2,147,483,648), 5 GB (5,368,709,120), 10 GB (10,737,418,240), 50 GB (53,687,091,200), or -1 for unlimited.
If set to true, expiration will also apply to files in child folders.
Folders were updated successfully.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Role ID
Role name
Role rank
Role type
LDAP Group ID
LDAP Group name
LDAP Group domain name
LDAP Group email
LDAP Group description
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Unique identifier (UUID) of the folder.
Unique identifier (UUID) of the parent object.
Name of the object.
Type of the object.f – File.d – Folder.
Unique identifier (UUID) who created the folder.
Unique identifier (UUID) for the user.
Email address associated with the user.
Full name of the user.
URL or identifier for the user's profile icon.
The date and time when the object was created.
The date and time when the object was last modified.
Expiration timestamp of the object, if applicable.
Unique identifier for the permission.
Name of the permission.
Indicates whether the permission is granted (True) or denied (False).
Indicates whether the object has been deleted.
Indicates whether the object has been permanently deleted.
Permanent URL link to access the object.
Path to the folder in the hierarchy.
Unique identifier (UUID) of the associated object (file or folder).
Role assigned to the member.
Unique identifier (UUID) of the user.
Unique identifier of the LDAP group.
User details of the member.
Role details assigned to the member.
Group details if the member belongs to a group.
Details of the user who shared the file or folder.
Date when the file or folder was shared.
Inherited role ID from the parent folder, if applicable.
List of allowed folder role IDs.
Email associated with the member.
Rank of the member role.
Vendor document ID associated with the object.
Name of the vendor document associated with the object.
Indicates whether the folder or the parent folder containing the file is marked as secure.
ID representing the source of the object (1 - Salesforce, 2 - Teams).
Indicates if the folder is shared with other users.
Indicates if the folder can be synced by Desktop Sync Client.
Time duration (in days) for which the files in this folder are kept after being added to the folder.
The description of the folder.
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Indicates if the folder is marked as a favorite by the user.
The number of files that have been pushed to mobile apps in this folder.
Role ID
Role name
Role rank
Role type
The Antivirus (AV) status of the folder.
The Data Loss Prevention (DLP) status of the folder.
Total number of members who have access to this folder.
Total number of subfolders within this folder.
Total number of files within this folder.
The maximum expiration date allowed for files in this folder.
The maximum duration (in days) that files in this folder can be kept after being added to the folder.
Indicates if the folder is part of an LDAP group.
Indicates if this folder is a subfolder of the user's "My Folder".
A list of IDs representing the path of the folder within the folder hierarchy.
Indicates if this folder is a root folder.
The ID of the root folder if this is a subfolder.
Indicates if a folder quota is applied to this folder.
The storage quota for the folder (in bytes).
The total storage size used by the folder (in bytes).
The amount of free space available in the folder (in bytes).
Indicates if a folder inherits permissions from the parent folder
Total number of items available.
Maximum number of items returned per page.
Number of items skipped before the current page.
Total number of deleted folders.
Total number of deleted files.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_ACCESS_USER, ERR_ENTITY_DELETED, ERR_ENTITY_DLP_LOCKED, ERR_ENTITY_IS_BASE_DIR, ERR_ENTITY_IS_MY_DIR, ERR_ENTITY_IS_SYNC_DIR, ERR_ENTITY_NOT_SCANNED, ERR_ENTITY_VIRUS_FOUND, ERR_PROFILE_COLLABORATION_DISABLED
Error code
Error message
Unprocessable Content
Possible error codes: ERR_INPUT_EXCEEDS_MAX_VALUE, ERR_INPUT_PAST_DATE, ERR_INVALID_PARAMETER, ERR_SYSTEM_EXTEND_FILE_EXPIRATION_DISABLED
Error code
Error message
Request blocked by WAF
curl -X PUT \
"https://{instance}.kiteworks.com/rest/admin/folders" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"string"
],
"expire": "2024-01-15",
"applyTo": "folders_only",
"quota": 1,
"applyToNestedFiles": true
}'import requests
url = "https://{instance}.kiteworks.com/rest/admin/folders"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
"Content-Type": "application/json",
}
payload = {
"ids": [
"string"
],
"expire": "2024-01-15",
"applyTo": "folders_only",
"quota": 1,
"applyToNestedFiles": true
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())