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

Need help?

Contact us
Kiteworks

Kiteworks Files API

The files API from Kiteworks — 61 operation(s) for files.

Documentation Provider Profile APIs.io OpenAPI GitHub

Kiteworks Files API is one of 41 APIs that Kiteworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 74 operations across 61 paths, and defines 57 schemas. It is described by OpenAPI 3.2.0, at version 28.

Requests are made against the base URL https://your.kiteworks.domain/rest.

74 operations 61 paths 57 schemas 11 DELETE28 GET7 PATCH25 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 74

Across 61 paths, the API surfaces 74 operations — 11 DELETE, 28 GET, 7 PATCH, 25 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Files 74
DELETE
/rest/files
Delete files
deleteRestFiles 3 params → 204403490
POST
/rest/files/actions/copy
Copy files
postRestFilesActionsCopy 5 params body → 201400401403413490
PATCH
/rest/files/actions/lock
Lock files
patchRestFilesActionsLock 5 params body → 200401403422490
POST
/rest/files/actions/mobileSyncItems
Add multiple files to mobile sync list
postRestFilesActionsMobileSyncItems 4 params → 200409490
DELETE
/rest/files/actions/mobileSyncItems
Delete multiple files from user mobile sync list
deleteRestFilesActionsMobileSyncItems 3 params → 204403490
POST
/rest/files/actions/move
Move files
postRestFilesActionsMove 5 params body → 201400401403413490
DELETE
/rest/files/actions/permanent
Delete files permanently
deleteRestFilesActionsPermanent 3 params → 204403490
POST
/rest/files/actions/push
Push files list to mobile sync list
postRestFilesActionsPush 4 params → 200490
DELETE
/rest/files/actions/push
Un-Push multiple files
deleteRestFilesActionsPush 3 params → 204490
PATCH
/rest/files/actions/recover
Recover deleted files
patchRestFilesActionsRecover 4 params → 200490
POST
/rest/files/actions/scan
Scan files for security
postRestFilesActionsScan 4 params → 200490
PATCH
/rest/files/actions/unlock
Unlock files
patchRestFilesActionsUnlock 5 params body → 200401403422490
GET
/rest/files/actions/zip
Download files and folders in ZIP format
getRestFilesActionsZip 8 params → 200403490
GET
/rest/files/actions/zipStatus
Get file and folder security status
getRestFilesActionsZipStatus 4 params → 200400401403422490
GET
/rest/files/{id}
Get file metadata
getRestFilesById 3 params → 200400401403490
PUT
/rest/files/{id}
Update a file
putRestFilesById 4 params body → 200401403422490
DELETE
/rest/files/{id}
Delete a file
deleteRestFilesById 1 param → 204403490
POST
/rest/files/{id}
Upload a file version
postRestFilesById 3 params body → 200403422490
PATCH
/rest/files/{id}/actions/lock
Lock a file
patchRestFilesByIdActionsLock 3 params → 200403490
DELETE
/rest/files/{id}/actions/permanent
Permanently delete a file
deleteRestFilesByIdActionsPermanent 1 param → 204401403490
POST
/rest/files/{id}/actions/push
Push file to mobile sync list
postRestFilesByIdActionsPush 3 params → 200490
DELETE
/rest/files/{id}/actions/push
Un-Push file from mobile sync list
deleteRestFilesByIdActionsPush 3 params → 204490
PATCH
/rest/files/{id}/actions/recover
Recover a file
patchRestFilesByIdActionsRecover 3 params → 200490
PATCH
/rest/files/{id}/actions/return
Check file into Repositories Gateway source
patchRestFilesByIdActionsReturn 3 params → 200490
POST
/rest/files/{id}/actions/scan
Scan a file for security
postRestFilesByIdActionsScan 3 params → 200490
PATCH
/rest/files/{id}/actions/unlock
Unlock a file
patchRestFilesByIdActionsUnlock 3 params → 200403490
GET
/rest/files/{id}/comments
Get file comments
getRestFilesByIdComments 21 params → 200490
POST
/rest/files/{id}/comments
Add file comment
postRestFilesByIdComments 3 params body → 200403422490
GET
/rest/files/{id}/content
Download a file
getRestFilesByIdContent 2 params → 200206401403490
GET
/rest/files/{id}/externalEdit
Get access token for external file edit
getRestFilesByIdExternalEdit 3 params → 200490
GET
/rest/files/{id}/members
Get users with access to a shared file
getRestFilesByIdMembers 13 params → 200400401403422490
DELETE
/rest/files/{id}/members
Remove all access to a shared file
deleteRestFilesByIdMembers 1 param → 200401403422490
GET
/rest/files/{id}/members/ldapGroup
List LDAP groups with access to a shared file
getRestFilesByIdMembersLdapGroup 10 params → 200490
GET
/rest/files/{id}/members/ldapGroup/{ldap_group_id}
Get a specific LDAP group's access to a shared file
getRestFilesByIdMembersLdapGroupByLdapGroupId 4 params → 200490
GET
/rest/files/{id}/members/{member_user_id}
Returns the specified user member associated with the file
getRestFilesByIdMembersByMemberUserId 4 params → 200490
PUT
/rest/files/{id}/members/{member_user_id}
Update file member
putRestFilesByIdMembersByMemberUserId 2 params → 200401403409422490
DELETE
/rest/files/{id}/members/{member_user_id}
Remove a user's access to a shared file
deleteRestFilesByIdMembersByMemberUserId 2 params → 200401403422490
GET
/rest/files/{id}/path
Get file path
getRestFilesByIdPath 2 params → 200490
GET
/rest/files/{id}/preview
Get file preview metadata
getRestFilesByIdPreview 1 param → 200400401403490
GET
/rest/files/{id}/tasks
Get file tasks
getRestFilesByIdTasks 30 params → 200490
POST
/rest/files/{id}/tasks
Create file task
postRestFilesByIdTasks 3 params body → 200403422490
POST
/rest/files/{id}/versions
Upload a file version
postRestFilesByIdVersions 3 params body → 200409403490
GET
/rest/files/{id}/versions
Get file versions
getRestFilesByIdVersions 12 params → 200490
GET
/rest/files/{id}/versions/{version_id}
Get a file version
getRestFilesByIdVersionsByVersionId 2 params → 200490
DELETE
/rest/files/{id}/versions/{version_id}
Delete a file version
deleteRestFilesByIdVersionsByVersionId 2 params → 204403490
POST
/rest/files/{id}/versions/{version_id}/actions/promote
Promote a file version
postRestFilesByIdVersionsByVersionIdActionsPromote 4 params → 200403490
POST
/rest/files/{id}/versions/{version_id}/actions/scan
Scan a file version for security
postRestFilesByIdVersionsByVersionIdActionsScan 4 params → 200403490
GET
/rest/files/{id}/versions/{version_id}/content
Download a file version
getRestFilesByIdVersionsByVersionIdContent 3 params → 200403490
GET
/rest/files/{id}/versions/{version_id}/preview
Get file preview metadata for a file version
getRestFilesByIdVersionsByVersionIdPreview 2 params → 200403490
POST
/rest/folders/{id}/actions/file
Upload a file using multipart form data
postRestFoldersByIdActionsFile 3 params body → 200409403422490
POST
/rest/folders/{id}/actions/fileBase64Encoded
Upload a base64-encoded file
postRestFoldersByIdActionsFileBase64Encoded 3 params body → 200409403490
POST
/rest/folders/{parent_id}/actions/fileFromTemplate
Create Microsoft Office document from template
postRestFoldersByParentIdActionsFileFromTemplate 1 param body → 200403422490
POST
/rest/folders/{parent}/files
Upload a file
postRestFoldersByParentFiles 4 params body → 200409403490
GET
/rest/permissions/file/{file_id}
Get file permissions
getRestPermissionsFileByFileId 9 params → 200490
GET
/rest/permissions/files
Get file permissions for a set of files
getRestPermissionsFiles 9 params → 200490
POST
/rest/requestFile/{ref}/actions/file
Upload a file requested by user
postRestRequestFileByRefActionsFile 3 params body → 200403422490
POST
/rest/requestFile/{ref}/comment/{object_id}
Add a comment to an uploaded file
postRestRequestFileByRefCommentByObjectId 4 params body → 200403422490
GET
/rest/requestFile/{ref}/sources/{object_id}/content
Download files from folder in request files to folder message
getRestRequestFileByRefSourcesByObjectIdContent 3 params → 200403490
GET
/rest/requestFile/{ref}/uploads/{object_id}/content
Download files uploaded to request files to folder or inbox message
getRestRequestFileByRefUploadsByObjectIdContent 3 params → 200403490
GET
/rest/sources/actions/downloadByTransaction
Download a file from Repositories Gateway source by transaction ID
getRestSourcesActionsDownloadByTransaction 2 params → 200490
POST
/rest/sources/actions/files/{id}
Upload a file version to Repositories Gateway source
postRestSourcesActionsFilesById 3 params body → 200403490
POST
/rest/sources/{id}/actions/file
Upload a file to Repositories Gateway source
postRestSourcesByIdActionsFile 3 params body → 200403490
POST
/rest/sources/{id}/actions/initiateDownload
Download a file asynchronously from Repositories Gateway source
postRestSourcesByIdActionsInitiateDownload 1 param → 200403490
GET
/rest/sources/{id}/content
Download a file from repositories gateway source
getRestSourcesByIdContent 1 param → 200490
GET
/rest/sources/{id}/preview
Get file preview metadata for a file in Repositories Gateway source
getRestSourcesByIdPreview 1 param → 200403490
GET
/rest/files/actions/content/link/{ref}
Download a file via a reference link
getRestFilesActionsContentLinkByRef 1 param → 200401403490
GET
/preview/file/{id}
Preview a file
getPreviewFileById 1 param → 200401403490
POST
/rest/files/members
Share files
postRestFilesMembers 6 params body → 201207401403409490
GET
/rest/files/shared
Get shared files
getRestFilesShared 6 params → 200401422490
DELETE
/rest/files/{id}/members/me
Remove access to shared file
deleteRestFilesByIdMembersMe 1 param → 200401403422490
GET
/rest/files/previewSupport
Get file preview status
getRestFilesPreviewSupport 1 param → 200400401490
POST
/rest/files/actions/downloadLink
Get link for downloading files and folders
postRestFilesActionsDownloadLink 2 params body → 200400401422490
PUT
/rest/admin/files
Update files
putRestAdminFiles 3 params body → 200401403422490
POST
/rest/admin/files/{id}/actions/rescan
Scan a file for security
postRestAdminFilesByIdActionsRescan 4 params → 201401403404409422490

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Folder (43 properties), SourceFile (29 properties), User (22 properties). Each schema is shown below with its type and property counts.

UserBasic
object
4 properties
Member
object
14 properties
Error
object
2 properties
BulkOperationLockFile
object
3 properties
Errors
object
1 property
Permission
object
3 properties
FilePreviewSupport
object
1 property
UserBasicInfo
object
4 properties 3 required
Folder
object
43 properties
MobileInfo
object
5 properties
MemberGroup
object
Class MemberGroup
9 properties 3 required
FileLockPostRequest
object
1 property
Task.Post
object
Class Task
5 properties 3 required
Comment
object
Class Comment
15 properties 5 required
RefreshToken
object
Class RefreshToken
4 properties 2 required
AdminFilePutRequest
object
2 properties 1 required
SafeEdit
object
2 properties
Preview
object
Class Preview
10 properties
AdminFileRescan
object
1 property
ErrorStringSchemaAccessVerifications
object
6 properties
Comment.Post
object
Class Comment
3 properties 1 required
UserMetadata
object
Class UserMetadata
2 properties
FilePathResponse
object
Represents the full ancestor path of a file, from the workspace root down to the file's parent folder. Returned by the GET /files/{id}/path endpoint.
2 properties
SyncedObject
object
4 properties
LdapGroup
object
Class LdapGroup
5 properties 2 required
Version
object
Class Version
22 properties 5 required
SourceFile
object
29 properties 5 required
AccessVerificationApproval
object
20 properties
Tag
object
3 properties
FileCopyPostBodyRequest
object
4 properties 1 required
BaseObject
object
Class Object
17 properties 4 required
FolderFileAddMembers
object
3 properties
FilePermissions
object
Class FilePermissions
2 properties
Fingerprint
object
2 properties
Files
object
1 property
FileUpdateRequest
object
3 properties
RiskPolicy
object
20 properties
Role
object
4 properties
Requirement
object
22 properties
DownloadLink
object
1 property
ErrorString
object
4 properties
MobileSync
object
15 properties
File
object
46 properties
Task
object
Class Task
17 properties 6 required
KPTransferStatus
object
Class KPTransferStatus
9 properties 6 required
Content.Post
object
Class Content
7 properties 2 required
Members
object
2 properties
FileMovePostBodyRequest
object
3 properties 1 required
SourceContent
object
Class SourceContent - if you need true EAPI entity use App\Entity\ECObject
20 properties 5 required
FileNameRequest.Post
object
2 properties
User
object
Class User
22 properties 6 required
FileMembersPostRequest
object
6 properties 1 required
SourcePreviewStatus
object
Represents the preview generation status for a file in a Repositories Gateway source. Returned by the GET /sources/{id}/preview endpoint (v15+).
3 properties
PushedObject
object
4 properties
Group
object
5 properties
MetaData
object
3 properties
PostFileZipStatusBodyRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-files-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks Activities API
AE Profile APIs.io
Kiteworks Admin API
AE Profile APIs.io
Kiteworks Advanced Forms API
AE Profile APIs.io
Kiteworks Cards API
AE Profile APIs.io
Kiteworks Client Event Logs API
AE Profile APIs.io
Kiteworks Clients API
AE Profile APIs.io
Kiteworks Comments API
AE Profile APIs.io
Kiteworks Contacts API
AE Profile APIs.io
Kiteworks Devices API
AE Profile APIs.io
Kiteworks Dli API
AE Profile APIs.io
Kiteworks External DL API
AE Profile APIs.io
Kiteworks Favorites API
AE Profile APIs.io
#File
← Back to K APIs
API Details
ID
kiteworks:kiteworks-files-api
Base URL
https://your.kiteworks.domain/rest
Docs
https://developer.kiteworks.com/api-endpoints.html
Provider
Kiteworks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=kiteworks-files-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/kiteworks-files-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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

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

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

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