# Kiteworks REST API Reference 400 endpoints across 39 resource groups. Each resource below links to a clean Markdown summary (parameters, request body, and responses as tables) and a raw OpenAPI spec slice. Interactive browser (requires JavaScript): https://developer.kiteworks.com/api-reference.html > **Authentication required.** All requests must include a Bearer access token in the > `Authorization` header. See [Authentication](https://developer.kiteworks.com/authentication.md) for how to > obtain a token using OAuth 2.0 Authorization Code (PKCE) or JWT Bearer flow. --- ## Webhook / PubSub Events 6 endpoints. Register, list, update, and delete PubSub webhooks that receive real-time Kiteworks events at a URL you control. - [Markdown summary](https://developer.kiteworks.com/api-reference/webhook.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/webhook.json) ## activities 2 endpoints. Read the audit/activity feed for the tenant or for a specific file. - [Markdown summary](https://developer.kiteworks.com/api-reference/activities.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/activities.json) ## admin 29 endpoints. Tenant administration: hostname aliases, admin-level mailbox actions, and other admin-only operations. - [Markdown summary](https://developer.kiteworks.com/api-reference/admin.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/admin.json) ## Admin Roles 5 endpoints. Manage admin roles and which users hold them. - [Markdown summary](https://developer.kiteworks.com/api-reference/adminRoles.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/adminRoles.json) ## cards 3 endpoints. Manage admin access-control cards (e.g. geo/IP-based access rules) and run actions on them. - [Markdown summary](https://developer.kiteworks.com/api-reference/cards.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/cards.json) ## Client Event Logs 1 endpoint. Submit client-side event logs from an OAuth client application. - [Markdown summary](https://developer.kiteworks.com/api-reference/clientEventLogs.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/clientEventLogs.json) ## clients 7 endpoints. Manage OAuth client applications (create/list/update/delete) and their granted scopes. - [Markdown summary](https://developer.kiteworks.com/api-reference/clients.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/clients.json) ## comments 7 endpoints. Read, add, update, and delete comments on files and folders. - [Markdown summary](https://developer.kiteworks.com/api-reference/comments.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/comments.json) ## contacts 5 endpoints. Manage a user's personal contact list. - [Markdown summary](https://developer.kiteworks.com/api-reference/contacts.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/contacts.json) ## devices 9 endpoints. Register, list, update, and remotely wipe mobile/desktop devices bound to user accounts. - [Markdown summary](https://developer.kiteworks.com/api-reference/devices.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/devices.json) ## Data Loss Investigation (DLI) 19 endpoints. Data Loss Investigation — generate and download forensic export archives and read per-file/per-user activity for compliance investigations. - [Markdown summary](https://developer.kiteworks.com/api-reference/dli.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/dli.json) ## External Distribution Lists 3 endpoints. Manage external (non-Kiteworks) distribution lists used as mail recipients. - [Markdown summary](https://developer.kiteworks.com/api-reference/externalDL.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/externalDL.json) ## favorites 5 endpoints. Mark and unmark files and folders as favorites for the current user. - [Markdown summary](https://developer.kiteworks.com/api-reference/favorites.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/favorites.json) ## files 65 endpoints. Core file operations: copy, move, lock/unlock, delete/recover, download as ZIP, security scanning, and file metadata. - [Markdown summary](https://developer.kiteworks.com/api-reference/files.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/files.json) ## folders 36 endpoints. Core folder operations: create, move, delete/recover, list shared folders, and trigger on-demand AV/DLP scans. - [Markdown summary](https://developer.kiteworks.com/api-reference/folders.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/folders.json) ## groups 5 endpoints. Manage Kiteworks user groups and group membership. - [Markdown summary](https://developer.kiteworks.com/api-reference/groups.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/groups.json) ## internal 1 endpoint. Internal-use endpoints (e.g. Advanced Forms submission upload links) not part of the primary public surface. - [Markdown summary](https://developer.kiteworks.com/api-reference/internal.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/internal.json) ## languages 2 endpoints. Look up supported UI languages. - [Markdown summary](https://developer.kiteworks.com/api-reference/languages.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/languages.json) ## LDAP Groups 5 endpoints. Manage LDAP-synced groups. - [Markdown summary](https://developer.kiteworks.com/api-reference/ldapGroups.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/ldapGroups.json) ## locations 4 endpoints. Manage named network/geographic locations used elsewhere for access policy. - [Markdown summary](https://developer.kiteworks.com/api-reference/locations.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/locations.json) ## mail 32 endpoints. Secure mail: read/send/delete/recover messages, mailbox counters, distribution list expansion, and read-state actions. - [Markdown summary](https://developer.kiteworks.com/api-reference/mail.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/mail.json) ## Mobile Sync 10 endpoints. Manage which files/folders are pushed to a user's mobile sync list. - [Markdown summary](https://developer.kiteworks.com/api-reference/mobileSync.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/mobileSync.json) ## notifications 3 endpoints. List and manage folder/user notification subscriptions and preferences. - [Markdown summary](https://developer.kiteworks.com/api-reference/notifications.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/notifications.json) ## permissions 1 endpoint. Look up the effective permissions a user has on a task, comment, or other object. - [Markdown summary](https://developer.kiteworks.com/api-reference/permissions.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/permissions.json) ## profiles 4 endpoints. Manage custom user "profile" types and their assignment. - [Markdown summary](https://developer.kiteworks.com/api-reference/profiles.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/profiles.json) ## Request File 11 endpoints. Public Request-a-File links: create a request, and let anonymous requesters upload/preview files against it. - [Markdown summary](https://developer.kiteworks.com/api-reference/requestFile.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/requestFile.json) ## roles 2 endpoints. Look up user roles. - [Markdown summary](https://developer.kiteworks.com/api-reference/roles.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/roles.json) ## SCIM Provisioning 15 endpoints. SCIM 2.0 user provisioning — create/read/update/delete users via the standard SCIM protocol for IdP integration. - [Markdown summary](https://developer.kiteworks.com/api-reference/scim.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/scim.json) ## search 3 endpoints. Full-text and structured search across files, folders, and mail, plus source-repository (e.g. SharePoint) search. - [Markdown summary](https://developer.kiteworks.com/api-reference/search.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/search.json) ## settings 2 endpoints. Read tenant-wide settings such as the password policy and system configuration. - [Markdown summary](https://developer.kiteworks.com/api-reference/settings.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/settings.json) ## Shared Mailbox 9 endpoints. Manage shared mailboxes: settings, membership, counters, and available web forms. - [Markdown summary](https://developer.kiteworks.com/api-reference/sharedMailbox.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/sharedMailbox.json) ## Short Links 1 endpoint. Resolve a Kiteworks short link to its target resource. - [Markdown summary](https://developer.kiteworks.com/api-reference/shortLinks.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/shortLinks.json) ## Source Types 2 endpoints. Look up which external content-repository (ECM) source types are available. - [Markdown summary](https://developer.kiteworks.com/api-reference/sourceTypes.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/sourceTypes.json) ## sources 20 endpoints. Connect and manage external content-repository (ECM/cloud storage) sources — auth, file listing, lock/unlock, transfer status. - [Markdown summary](https://developer.kiteworks.com/api-reference/sources.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/sources.json) ## system 10 endpoints. System/node health monitoring and EPGDB backup import/export operations (admin/ops use). - [Markdown summary](https://developer.kiteworks.com/api-reference/system.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/system.json) ## uploads 11 endpoints. The chunked upload protocol shared by file, folder, mail-attachment, and request-file uploads — initiate a session, then upload chunks. - [Markdown summary](https://developer.kiteworks.com/api-reference/uploads.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/uploads.json) ## User SSH Public Keys 7 endpoints. Register, generate, list, and delete a user's SSH public keys (used for SFTP/SSH-based access). - [Markdown summary](https://developer.kiteworks.com/api-reference/userSshPublicKeys.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/userSshPublicKeys.json) ## users 36 endpoints. Core user account operations: login, current-user profile, password/mobile-number updates, and LDAP user lookup. - [Markdown summary](https://developer.kiteworks.com/api-reference/users.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/users.json) ## Web Forms 2 endpoints. List and read secure web forms available to a user or shared mailbox. - [Markdown summary](https://developer.kiteworks.com/api-reference/webForms.md) - [OpenAPI spec slice](https://developer.kiteworks.com/assets/specs/webForms.json) --- Full spec files: [Pub-Sub APIs YAML](https://developer.kiteworks.com/assets/PubSub-APIs.yml) · [Core APIs JSON](https://developer.kiteworks.com/assets/Kiteworks-APIs-V28.json)