Return lists of files/folders/emails from search results
Searches across files, folders, and emails using the provided query. Returns matching results grouped by type, along with total counts and a flag indicating whether full-text search is enabled.
Id of folder to search
Search by content
Search by content. Search for results that contain the specified characters in this parameter.
Search by description
Search by description. Search for results that contain the specified characters in this parameter.
Search by user
Search by modified date
Search by modified date. Search for results where this parameter value is greater than the specified value.
Search by modified date. Search for results where this parameter value is greater than or equal to the specified value.
Search by modified date. Search for results where this parameter value is less than the specified value.
Search by modified date. Search for results where this parameter value is less than or equal to the specified value.
Search by created date
Search by created date. Search for results where this parameter value is greater than the specified value.
Search by created date. Search for results where this parameter value is greater than or equal to the specified value.
Search by created date. Search for results where this parameter value is less than the specified value.
Search by created date. Search for results where this parameter value is less than or equal to the specified value.
Search by lock status
Search by lock status. Search for results where this parameter value is greater than the specified value.
Search by lock status. Search for results where this parameter value is greater than or equal to the specified value.
Search by lock status. Search for results where this parameter value is less than the specified value.
Search by lock status. Search for results where this parameter value is less than or equal to the specified value.
Search by file size
Search by file size. Search for results where this parameter value is greater than the specified value.
Search by file size. Search for results where this parameter value is greater than or equal to the specified value.
Search by file size. Search for results where this parameter value is less than the specified value.
Search by file size. Search for results where this parameter value is less than or equal to the specified value.
Search by file type. Accepted values: Documents, Spreadsheets, Presentations, Images, PDF, Multimedia, Text.
Search by email type. Accepted values: Inbox, Draft, Sent.
Search files by tracking ID (UUID)
Search files/folders by path. If this is specified, other search criteria is no longer valid.
Search files/folders by path. If this is specified, other search criteria is no longer valid.. Search for results that contain the specified characters in this parameter.
Search by object type. Accepted values: f, d, m, k.
Scope of the search. Accepted values: all, shared.
Search only files shared to me.
Id of shared mailbox to search
Sorting options
Offset
Limit
With parameters
Determines the detail level of the response body.
Search results retrieved 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.
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
Email unique identifier
Unique identifier of User who sent Email
Email template unique identifier
Email status. Accepted values: sent, draft, queued, transferring, error, self_send
Email type. Accepted values: original, resend, forward, reply
Date and time the email was created
Indicates whether the email is deleted
Email Package unique identifier
Indicates whether the email is a preview email
Indicates whether the email was sent by a user
The watermark on the preview 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.
Details of the DRM-protected file associated with the attachment.
Access type for the attachment (e.g., read-only, editable).
List of tags associated with the attachment.
List of permissions associated with the attachment.
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).
List of alternative fingerprints for the attachment file.
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.
Email package expiration date
Number of attachments in the email package
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
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 email body is secured
Date and time the email was last modified
Unique identifier of the original email this email was forwarded or replied from
Email unique identifier for return receipt
The unique identifier of the user
The name of the user
The user's email
URL to the user's profile icon image
User ID for Return Receipt
Error message when the email status is error
Subject line of the email as shown to recipients
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
Indicates whether the email has been read by the current user
Mailbox bucket the email belongs to. Accepted values: inbox, sent, draft, outgoing, trash
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
(Explicit field. May be retrieved only if mentioned in "with" parameter)
HATEOAS links associated with the entity
Total items count
Total files count
Total folders count
Total emails count
Search unique identifier
Indicates whether full text search is enabled
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/search" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/search"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Search SharePoint sites
Description:
Searches for SharePoint sites accessible through the specified source connection.Precondition:
User must have a valid SharePoint Online source connection configured.Response:
Returns a list of matching SharePoint sites.The unique identifier of the entity.
If true, includes Kiteworks native sources in the results.
If true, includes container-type sources (e.g. SharePoint document libraries) in the results.
Maximum number of results to return.
Number of results to skip before returning results, for pagination.
Search query string to filter sources or sites by name.
Type of search to perform against the source.
SharePoint sites have been successfully returned.
Display name of the SharePoint site.
Indicates whether the site has already been added as an external content source.
URL of the SharePoint site.
External content management type identifier.
Repository identifier within the SharePoint site.
Unique identifier of the SharePoint site.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_AUTH_EC_UPDATE_TOKEN, ERR_SPO_SEARCH
Error code
Error message
Request blocked by WAF
curl -X GET \
"https://{instance}.kiteworks.com/rest/sources/:id/query" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
id = "VALUE" # The unique identifier of the entity.
url = f"https://{{instance}}.kiteworks.com/rest/sources/{id}/query"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
response = requests.get(url, headers=headers)
print(response.json())Perform a search query
Description:
Searches for files, folders, or emails based on the provided query parameters.Precondition:
The user must be authenticated.Response:
Returns a list of matching files, folders, or emails.Sorting:
Sorting can be applied using two query parameters: `orderBy` for the field name, and `orderType` for the sort order, which can be either `asc` or `desc`.Sorting options:
| FIELD_NAME | Description |
|---|---|
| score | The search relevance score |
| 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 |
Range limit.
Range offset.
Indicates whether it is a full-text search or a database search.
Comma-separated list of object types to search.f – Files.d – Folders.e – Emails.
Search query string.
Search within a specific folder ID.
Exact creation date.
Created after the specified date.
Created on or after the specified date.
Created before the specified date.
Created on or before the specified date.
Exact modified date.
Modified after the specified date.
Modified on or after the specified date.
Modified before the specified date.
Modified on or before the specified date.
Exact file size in bytes.
File size greater than the specified value.
File size greater than or equal to the specified value.
File size less than the specified value.
File size less than or equal to the specified value.
User email of the folder creator.
List of comma-separated file types to filter search results.
If true, only includes files shared with the user.
Shared mailbox ID.
Field to sort results by.
Allowed values: score, name, created, modified.
Sort direction for the results.asc – Ascending order.desc – Descending order.
If true, searches only for file/folder names.
Email subject filter.
Sender ID.
Recipient ID.
File name filter.
Folder name filter.
Search within file content.
If true, provides spelling suggestions for the search query.
Filter email search results by mailbox folder.inbox – Search in the inbox.sent – Search in sent items.
Search within a specific folder path.
Filter files by their tracking ID (UUID).
Comma-separated file extensions to filter (e.g., "pdf,form" or ".pdf,.form").
Search completed 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
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.
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.
Details of the DRM-protected file associated with the attachment.
Access type for the attachment (e.g., read-only, editable).
List of tags associated with the attachment.
List of permissions associated with the attachment.
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).
List of alternative fingerprints for the attachment file.
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.
Total number of matching files.
Total number of matching folders.
Total number of matching emails.
List of email address suggestions related to the search query.
List of file name suggestions related to the search query.
Dictionary of file IDs to highlighted text snippets from full-text search.
Unauthorized
Possible error codes: ERR_AUTH_INVALID_CSRF, ERR_AUTH_UNAUTHORIZED
Error code
Error message
Forbidden
Possible error codes: ERR_PROFILE_COLLABORATION_DISABLED
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/query?includeContent=VALUE&searchType=VALUE" \
-H "Authorization: Bearer YOUR_TOKEN"import requests
url = "https://{instance}.kiteworks.com/rest/query"
headers = {
"Authorization": "Bearer YOUR_TOKEN",
}
params = {
"includeContent": "VALUE",
"searchType": "VALUE",
}
response = requests.get(url, params=params, headers=headers)
print(response.json())