Keep your integration
up to date
Every Kiteworks API release brings new capabilities, security improvements, and refinements. Use these resources to understand what changed between versions and upgrade your integration with confidence.
Changelog & Upgrade Guides
Upgrade with Confidence
Use the API Changelog to diff any two Kiteworks API versions and see exactly what changed. Then follow the step-by-step upgrade guides to update your integration — covering authentication flow changes, the required v28 header, removed endpoints, and UUID ID migrations across files, mail, and users.
API Changelog
Browse all API changes between any two Kiteworks versions. Filter by version range, API tag, or keyword. Clearly marks breaking changes, warnings, and informational updates.
Check Your API Version
Four ways to identify which API version your integration is currently using — Admin UI, code search, API Playground, or the versions endpoint. Start here before any upgrade.
Upgrade to OAuth 2.0
Migrate from deprecated Signature or User Credentials flows to Authorization Code (OAuth 2.0) or JWT Assertion. Covers Admin UI registration and token exchange code samples.
Upgrade to API v28
Add the required X-Accellion-Version: 28 header, handle version errors, replace 8 removed endpoints, and update removed request parameters on user delete and profile endpoints.
Update Files & Folders to UUID (v18 to v19+)
Update path params, query params, request body fields, and response parsing for files and folders. Required if your integration targets API v18 or earlier.
Update Mail & Email to UUID (v20 to v21+)
Update ID handling for mail messages, email packages, shared mailboxes, and DLI mail. Required if your integration targets API v21 or earlier.
Update Users to UUID (v21 to v22+)
Update user ID handling across admin users, standard users, admin roles, and related entities (Contacts, Devices, DLI Exports, and more). Required if targeting API v22 or earlier.