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

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

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

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

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

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

3 operations 3 paths 5 schemas 1 DELETE1 GET1 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 3

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

notifications 3
PUT
/rest/folders/{id}/actions/setNotifications
Set/Update notifications
5 params body → 200422490
GET
/rest/notifications
List notifications
11 params → 200490
DELETE
/rest/notifications/{object_id}
Remove notification options
1 param → 204403490

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are UserNotification (5 properties), MetaData (3 properties), UserNotification.Post (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
Error
object
2 properties
UserNotification
object
Class Notification
5 properties 1 required
UserNotification.Post
object
Class Notification
3 properties
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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