Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kiteworks requestFile API

The requestFile API from Kiteworks — 13 operation(s) for requestfile.

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

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

This API exposes 15 operations across 13 paths, and defines 30 schemas. It is described by OpenAPI 3.0.2, at version 28.

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

15 operations 13 paths 30 schemas 2 DELETE8 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 15

Across 13 paths, the API surfaces 15 operations — 2 DELETE, 8 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

requestFile 15
POST
/rest/folders/{id}/actions/requestFile
Send a Request File to Folder request
1 param body → 201400401403422490
DELETE
/rest/requestFile/{ref}
Expire a request file link
1 param → 204403490
GET
/rest/requestFile/{ref}
Returns Request File Info by ref
2 params → 200401403490
POST
/rest/requestFile/{ref}/actions/file
Upload a file requested by user
3 params body → 200403422490
POST
/rest/requestFile/{ref}/comment/{object_id}
Add a comment to an uploaded file
4 params body → 200403422490
GET
/rest/requestFile/{ref}/preview/{object_id}
Get preview metadata for a source file
2 params → 200403490
GET
/rest/requestFile/{ref}/sources
Get source files attached by the requester
1 param → 200403490
GET
/rest/requestFile/{ref}/sources/{object_id}
Get source file metadata
4 params → 200403490
GET
/rest/requestFile/{ref}/sources/{object_id}/content
Download files from folder in request files to folder message
3 params → 200403490
GET
/rest/requestFile/{ref}/uploads
Get files uploaded by the current user
1 param → 200403490
GET
/rest/requestFile/{ref}/uploads/{object_id}
Get uploaded file metadata
4 params → 200403490
DELETE
/rest/requestFile/{ref}/uploads/{object_id}
Delete an uploaded file
2 params → 204403490
GET
/rest/requestFile/{ref}/uploads/{object_id}/content
Download files uploaded to request files to folder or inbox message
3 params → 200403490
POST
/rest/mail/actions/requestFile
Request files to inbox
3 params body → 201400401403422490
POST
/rest/requestFile/{ref}/reply
Reply to Request File
1 param body → 201400401403422490

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Folder (43 properties), BaseObject (17 properties), Comment (15 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
RequestFileSource
object
Class RequestFileSource
4 properties
PushedObject
object
4 properties
UserBasic1
object
2 properties
Tag
object
3 properties
RequestFileToFolderPostRequest
object
9 properties 2 required
Preview
object
Class Preview
10 properties
MetaData
object
3 properties
UserBasic
object
4 properties
RequestFileUpload
object
Class RequestFileUpload
2 properties
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 required
Folder
object
43 properties
Error
object
2 properties
Role
object
4 properties
RequestFileConfig
object
1 property
File
object
46 properties
Comment.Post
object
Class Comment
3 properties 1 required
MobileInfo
object
5 properties
Fingerprint
object
2 properties
RequestFileReplyPostRequest
object
1 property
RequestFile
object
13 properties
Member
object
14 properties
RequestFilePermission
object
2 properties
Mail2
object
8 properties
SafeEdit
object
2 properties
RequestFileToInboxPostRequest
object
8 properties 2 required
Group
object
5 properties
BaseObject
object
Class Object
17 properties 4 required
Comment
object
Class Comment
15 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-requestfile-api-openapi.yml Raw ↑

Other APIs Kiteworks publishes across the network.

Kiteworks activities API
Kiteworks admin API
Kiteworks adminRoles API
Kiteworks advancedForms API
Kiteworks cards API
Kiteworks clientEventLogs API
Kiteworks clients API
Kiteworks comments API
Kiteworks contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API