This FAQ addresses common questions regarding the transition and upgrade process from the 2022-01-01 version of the Workiva Platform APIs to the upcoming 2026-01-01 version.

General Information

What is changing in the Workiva Platform APIs?

The 2026 version of the Workiva Platform APIs introduces significant improvements across multiple areas, including:

• Improved Consistency and Predictability: Enhanced adherence to RESTful principles for more intuitive resource interactions. Going forward, major versions of the Platform APIs will be supported for 3 years, and there will be two major version releases per year (Spring and Fall)
• New Functionality: Introduction of new endpoints and capabilities, previously only available in Prototype such as 
• User, Workspace, and Organization Management endpoints, 
• Content Endpoints for Documents and Spreadsheets 
• Range Linking endpoints
• Files Management endpoints
• Deprecation of Legacy Features: Endpoints in the 2022 version of the API are now considered deprecated (more on what that means below)

When will the 2026 Workiva Platform APIs be released?

The 2026 Workiva Platform APIs are scheduled for General Availability (GA) on January 26, 2026. There will be various features that are additively released to the first 2026 version as fast-follows. These include Scripting APIs and Chain support for API versioning with commands, nodes and connectors.

How long will the 2022 API version be supported?

The 2022 version of the Workiva Platform APIs will enter a Deprecation Phase upon the GA release of the 2026 version in January 2026. Sunset for the 2022 version is currently scheduled for January 2029. We strongly recommend completing your migration before the Sunset date.

What is changing on our API?

More details are shared on our Upgrade Guide.

What is the primary benefit of upgrading?

Upgrading ensures your integrations remain compatible with the latest Workiva Platform features, benefit from enhanced security, experience better performance, and leverage new capabilities not available in the 2022 version.

Does Workiva have a release cadence for major versions of the platform APIs?

Yes, going forward from the 2026-01-01 major release Workiva will have two release windows per year for new major versions; Spring and Fall. In the event that there are no breaking changes when a release date approaches and the release candidate for that period is empty, we will not publish a new version of the API at that time. 

New versions will only be released during the Spring and Fall window if there are breaking changes required to be made.

Can I mix multiple versions of the APIs in my integration?

Workiva only commits to API functionality within a single major version of the API. We strongly recommend that users do not have multiple versions of our APIs being used simultaneously within a singular integration, script, or chain. 

Example; User has a chain composed entirely of endpoints within version 2026-01-01, great that should work and we support that.

As opposed to a user having a chain that makes some API calls to 2022 and other API calls to 2026 in the same chain or script, we do NOT guarantee that will work and advise against that.

What is going to happen to the Prototype APis?

The Prototype APIs will be visually removed from the developer site however they will continue to function normally. Prototype APIs will be supported through January 2027, ensuring users have ample time to transition to the 2026-01-01 version of the API. Going forward, API Previews will replace the Prototype APIs.

What are API Previews?

API Previews are the way that users can give feedback on new APIs that will be promoted to general availability before they’re shipped. API Previews will be short lived (30-60 days) and targeted towards a specific feature set (e.g. there could be an API Preview specifically for Processes APIs). Please ensure that your Organization has signed the Preview Feature Agreement in order to participate in these previews. If you haven’t or aren’t sure if your Organization has signed the agreement please reach out to your CSM.

What does this mean for Workiva Scripting?

Workiva Scripting APIs will remain in Prototype until they are ready to be promoted to general availability later in 2026, at which time they will be shipped into the current major version as additive changes.

The Scripting APIs in Prototype will remain suppressed until the end of January, 2027, when they will be shut down alongside the rest of the Prototype API’s.

Partners and Customers are highly encouraged to upgrade to the 2026-01-01 version of the Scripting APIs when they are generally available as soon as possible.

Users should be able to start sending the version header as part of their python code as soon as they are ready to upgrade to the latest version of the API

Support Articles will be published to our customer facing enablement sites that cover best practices for Scripting and version control with APIs after the release of our January 2026 version.

What does this mean for Chains?

The Chains APIs are for the time being out of scope of our new version policy and will not be part of this release or change. 

Support for making a Chain that utilizes the new version of the Platform API, as well as Connector support for new versions of the Platform API will be coming after the 2026-01-01 version release, some time in 2026.

Users will be able to utilize the 2026-01-01 version of the API through HTTP Request Connector if they build out the command manually.

Chains commands and connectors built on the 2022-01-01 will continue to function as normally and be supported throughout the lifetime of the 2022-01-01 version of the Platform APIs.

Users that are already leveraging the HTTP Request connector to interact with the 2022 and prototype versions of the APIs will need to update those commands in order to take advantage of features in the 2026-01-01 version if you would like to.

What does this mean for Wdata?

The Wdata APIs are for the time being out of scope of our new version policy and will not be part of this release or change. They will continue to be considered separate from the Platform APIs until otherwise announced.

Technical Migration Details

What are the most significant breaking changes I should prepare for?

Key breaking changes include:

1. Endpoint Path Changes: Many resource paths have been updated for better consistency. For example, a resource previously accessed at /v1/workspaces/{id}/documents might move to /documents/search?workspace_id={id}.
1. The version of the API being used will no longer be part of the URL schema and is instead indicated at the x-version header level going forward
2. Request/Response Schema Changes: Data models for several resources have been normalized. This means fields may be renamed, relocated, or have different data types (e.g., a field that accepted an integer might now require a string UUID).

Is there a compatibility layer or feature flag for gradual adoption?

No, the 2026 API is a distinct version. We strongly recommend testing the new endpoints in a dedicated non-production environment. We will maintain the 2022 version in parallel until the sunset date, allowing you to run both versions simultaneously during the transition period.

Where can I find detailed documentation for the 2026 APIs?

The comprehensive Workiva Developer Portal will host the full OpenAPI Specification and detailed guides for the 2026 APIs starting with the Public Preview in.

Are all 2022 API functionalities available in the 2026 version?

While the vast majority functionalities are retained, some legacy, less-used endpoints from 2022 have been retired. Conversely, several entirely new features are available. We recommend cross-referencing your current usage against the 2026 API documentation.

Planning and Support

What steps should I take to plan my upgrade?

We recommend the following phased approach:

1. Audit: Identify all current API integrations using the 2022 version. Document the endpoints, methods, and data models currently in use.
1. In Chains specifically, this would also involve auditing your connections and command usage as well.
2. Review: Compare your audited usage against the 2026 API documentation to identify necessary code changes.
3. Test: Begin development and rigorous testing. Focus on critical path integrations first.
4. Deploy: Schedule the deployment of the upgraded integrations into your production environment well before the January 2029 Sunset date. Prototype APIs will be shut down at the end of January 2027, before the 2029 sunset date of the 2022 version.

What resources are available to help with the migration?

• Migration Guide: A dedicated "2022 to 2026 Migration Guide" detailing all breaking changes and recommended replacements will be released with the Public Preview.
• In depth Legacy Spreadsheets Guide: A deep dive guide into every Legacy Spreadsheets endpoint and where to access that functionality in the new major version of the Platform API will be available to support heavy users of that feature set.
• Developer Support: Workiva Developer Support teams are available to assist with specific integration challenges.
• Community Page: The Workiva Community Support Forums is a great place for all things API and Scripting

Who should I contact if I have further questions?

Please contact your dedicated Workiva Customer Success Account Manager or reach out to us via the Workiva APIs & Scripting topic on the Workiva Community