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

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

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

Tagged areas include search. 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 31 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 31 schemas 3 GET

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 — 3 GET. Each is listed below with its method, path, parameters, and response codes.

search 3
GET
/rest/search
Return lists of files/folders/emails from search results
43 params → 200490
GET
/rest/sources/{id}/query
Search SharePoint sites
7 params → 200401403490
GET
/rest/query
Perform a search query
39 params → 200401403422490

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are File (46 properties), Mail (45 properties), Folder1 (44 properties), Folder (43 properties). Each schema is shown below with its type and property counts.

Errors
object
1 property
PushedObject
object
4 properties
Tag
object
3 properties
TrackingAccessRecipient
object
6 properties
SearchSharePointSitesResult
object
1 property
Folder1
object
44 properties
UserBasic
object
4 properties
Attachment
object
19 properties
Recipient
object
5 properties
Mail
object
45 properties
SearchResult
object
9 properties
Email
object
Class Email
36 properties 10 required
Permission
object
3 properties
UserBasicInfo
object
4 properties 3 required
Folder
object
43 properties
Error
object
2 properties
Role
object
4 properties
File
object
46 properties
DrmFile
object
2 properties
MobileInfo
object
5 properties
Fingerprint
object
2 properties
EmailReturnRecipient
object
2 properties
Member
object
14 properties
SafeEdit
object
2 properties
EmailReturnReceipt
object
Class Recipient
3 properties 2 required
Package
object
9 properties
Site
object
6 properties
Search
object
Class Search
6 properties 4 required
Variables
object
2 properties
Group
object
5 properties
SearchMetadata
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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