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

The favorites API from Kiteworks — 3 operation(s) for favorites.

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

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

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

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

5 operations 3 paths 15 schemas 2 DELETE1 GET2 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 5

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

favorites 5
POST
/rest/favorites
Add a favorite
2 params body → 200409422490
GET
/rest/favorites
List favorites
9 params → 200401403490
DELETE
/rest/favorites/{id}
Remove a favorite
1 param → 204403490
POST
/rest/folders/actions/favorite
Set multiple folders as favorite
4 params → 200409490
DELETE
/rest/folders/actions/favorite
Removes specified folders from favorites
3 params → 204403490

Schemas 15

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

UserBasicInfo
object
4 properties 3 required
Errors
object
1 property
Member
object
14 properties
UserBasic
object
4 properties
FavoriteListOpenAPI2
object
2 properties
Folder
object
43 properties
Favorite
object
Class Favorite
6 properties 3 required
Favorite.Post
object
Class Favorite
2 properties 1 required
Error
object
2 properties
Role
object
4 properties
Folder1
object
44 properties
Group
object
5 properties
FavoriteOpenAPI2
object
4 properties
Permission
object
3 properties
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kiteworks-favorites-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