API Fundamentals

Kiteworks API Endpoint Categories

The Kiteworks API covers the full breadth of the platform, organised into seven categories. This page describes what each category does and which resources it exposes. For full endpoint specifications — parameters, request bodies, and response schemas — use the API Reference.

The interactive API explorer is also available directly on your instance at https://<your-instance>.kiteworks.com/rest/index.html.

Content APIs

Content APIs provide access to the files, folders, and enterprise content sources that make up the Kiteworks platform. Most integrations will use these endpoints as their primary building blocks.

`/users`

A natural starting point for any integration. The users endpoints let your application retrieve information about the authenticated user — their ID, name, email, account status, and the IDs of their root folders. Use GET /users/me to anchor further navigation through the folder and file tree.

`/folders`

Comprehensive folder management: create, update, retrieve, and delete folders; browse subfolders; list folder contents; and configure access permissions. Folders are the primary container for all user content in Kiteworks.

`/files`

Full file lifecycle management alongside folders. File endpoints cover upload and download, copy, move and delete, lock and unlock, versioning, and file sharing. See File Operations for task-based guides covering common file workflows.

`/sources`

Kiteworks can connect to external enterprise content repositories — such as Microsoft SharePoint or EMC Documentum — through a single interface. The sources endpoints let your application access and manage these enterprise content sources in the same way as native Kiteworks content.

Collaboration APIs

Collaboration APIs expose the tools users rely on to work together in Kiteworks — mail, comments, and tasks. These endpoints let your application participate in or orchestrate collaborative workflows on behalf of authenticated users.

`/mail`

Send and receive email on behalf of the authenticated user. Mail in Kiteworks travels through the platform's secure messaging layer, so all content remains governed by your organization's policies.

`/comments`

Direct access to existing comments for update and delete operations. For creating comments, use the comment-related endpoints nested under /files.

`/tasks`

Direct access to existing tasks for update and delete operations. As with comments, task creation is handled through the endpoints nested under /files.

Preferences APIs

Preferences APIs manage per-user settings: folder notifications, favorite folders, and locale configuration. These are typically used in integrations that mirror or extend the Kiteworks user experience.

Endpoint	Purpose
`/notifications`	Manage notification settings for folders — which events trigger alerts for the authenticated user.
`/favorites`	Add, list, and remove the authenticated user's favorite folders.
`/languages`	Retrieve the list of languages supported by the Kiteworks instance.
`/timezones`	List all supported time zones, including names and UTC offsets.

Contacts APIs

Contacts APIs manage the people and groups an authenticated user can share content with or send mail to.

`/contacts`

Create, update, and delete the authenticated user's personal contacts.

`/groups`

Manage personal contact groups. A user can define groups of contacts and then use those groups when granting folder access or addressing mail — rather than specifying individuals one by one.

`/ldapGroups`

Available on instances integrated with an LDAP directory. Administrators can expose LDAP groups to end users for folder sharing. These endpoints let your application add, update, or remove which LDAP groups are available.

Security APIs

Security APIs manage the access control layer — user profiles, folder roles, administrator role assignments, and device tracking.

`/profiles`

Retrieve the list of user profiles defined in the system and inspect the features and permission settings associated with each one. Profiles determine what actions users can perform across the platform.

`/roles`

Retrieve the folder roles defined in the system. Roles control what a user can do within a specific folder (e.g. viewer, contributor, manager).

`/adminRoles`

Assign and manage administrator roles for users. This endpoint requires authentication with an Administrator account.

Only a System Administrator can promote users to the System Administrator or Application Administrator role. A user cannot elevate their own privileges using this endpoint.

`/devices`

Track the devices — mobile phones, tablets, and desktop clients — that users have connected to their Kiteworks accounts. These endpoints also support remote wipe, allowing administrators to revoke access from a lost or compromised device.

`/admin`

A privileged set of endpoints that mirror many of the standard resource endpoints but operate at a system-wide scope. Requires authentication with an Administrator account. Covers:

/admin/clients — create and configure registered client applications; list available API scopes.
/admin/devices — list, audit, update, and remove user devices.
/admin/ldapGroups — list, create, and delete LDAP groups system-wide.
/admin/licenses — upload a new platform license.
/admin/locations — manage Kiteworks Locations (System Administrator only; on-premises Enterprise and Enterprise Connect packages).
/admin/profiles — list user profiles across the system.
/admin/sources — list, add, update, and remove Enterprise Connect sources.
/admin/users — list, add, update, and delete users; manage settings, admin roles, and profile images.

Client Management APIs

Client Management APIs control which applications are registered to connect to the Kiteworks platform and what they are permitted to do.

`/clients`

Register new client applications and manage their configuration — the same applications you create in the Admin console. See Create a Custom Application for a walkthrough of the registration process.

`/scopes`

Retrieve the full list of API scopes supported by the platform. Use this endpoint to programmatically discover which operations are available so your application can request only the permissions it needs. See Available Scopes for a reference table.

Maintenance APIs

Maintenance APIs support operational tasks on the Kiteworks instance itself. Currently this category contains a single endpoint.

`/licenses`

Upload a new license file to the Kiteworks instance. Intended for applications that automate platform lifecycle management, such as license renewal scripts or deployment automation tooling.

Next Steps

Ready to start calling endpoints? Here's where to go next:

API Reference → Full endpoint specifications with parameters, request bodies, and response schemas
Upload Files → Practical guide to uploading files via the /files endpoints
API Playground → Try these endpoints live against your own instance