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

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

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

Tagged areas include clients. 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 8 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 8 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.

clients 7
GET
/rest/clients
List clients
8 params → 200490
POST
/rest/clients
Create a client
2 params body → 200409422490
GET
/rest/clients/me
Get current client
→ 200490
GET
/rest/clients/{id}
Get a client
1 param → 200490
PUT
/rest/clients/{id}
Update a client
1 param body → 200403490
DELETE
/rest/clients/{id}
Delete a client
1 param → 204403490
GET
/rest/clients/{id}/scopes
List scopes of a client
2 params → 200490

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ClientNew (23 properties), Client (22 properties), Client.Post (8 properties), Client.Put (8 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
ClientScopesResponse
object
Represents the success response for the client scopes endpoint.
1 property
Error
object
2 properties
Client
object
Class Client
22 properties 2 required
ClientNew
object
Class ClientNew
23 properties 2 required
Client.Put
object
Class Client
8 properties 4 required
Client.Post
object
Class Client
8 properties 4 required
MetaData
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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