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 comments API

The comments API from Kiteworks — 4 operation(s) for comments.

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

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

This API exposes 7 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.2, at version 28.

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

7 operations 4 paths 14 schemas 1 DELETE4 GET1 POST1 PUT

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 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

comments 7
GET
/rest/comments/{id}
Get a comment
3 params → 200490
PUT
/rest/comments/{id}
Update a comment
1 param body → 200422490
DELETE
/rest/comments/{id}
Delete a comment
1 param → 204490
GET
/rest/files/{id}/comments
Get file comments
21 params → 200490
POST
/rest/files/{id}/comments
Add file comment
3 params body → 200403422490
GET
/rest/folders/{id}/comments
List comments for the folder
21 params → 200490
GET
/rest/permissions/comment/{comment_id}
Return the list of permissions available on a comment
9 params → 200490

Schemas 14

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

UserBasicInfo
object
4 properties 3 required
Comment.Put
object
Class Comment
2 properties 1 required
Member
object
14 properties
Folder
object
43 properties
UserBasic
object
4 properties
Errors
object
1 property
Error
object
2 properties
Role
object
4 properties
Comment.Post
object
Class Comment
3 properties 1 required
MetaData
object
3 properties
Group
object
5 properties
BaseObject
object
Class Object
17 properties 4 required
Comment
object
Class Comment
15 properties 5 required
Permission
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-comments-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 contacts API
Kiteworks devices API
Kiteworks dli API
Kiteworks externalDL API
Kiteworks favorites API