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

The contacts API from Kiteworks — 2 operation(s) for contacts.

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

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

This API exposes 5 operations across 2 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.

5 operations 2 paths 8 schemas 1 DELETE2 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 5

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

contacts 5
POST
/rest/contacts
Create a contact
body → 201401409422490
GET
/rest/contacts
List contacts
5 params → 200400401490
PUT
/rest/contacts/{id}
Update a contact
1 param body → 200401403409422490
GET
/rest/contacts/{id}
Get a contact
1 param → 200401403490
DELETE
/rest/contacts/{id}
Delete a contact
1 param → 204401403490

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Contact (7 properties), ContactItem (3 properties), MetaData (3 properties), ContactList (2 properties). Each schema is shown below with its type and property counts.

ContactEmail
object
1 property 1 required
Errors
object
1 property
ContactList
object
2 properties
Error
object
2 properties
ContactItem
object
3 properties
Contact
object
7 properties
MetaData
object
3 properties
ContactCreate
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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