Versioning#

API Versioning at Workiva#

The Workiva API uses date-based versioning so customers can rely on a stable contract without breaking existing integrations. A version is selected with the X-Version request header and is named by release date in YYYY-MM-DD form (for example, X-Version: 2026-01-01). There is no version segment in the URL path.

Feature Previews#

The GRC API is released as a feature preview — a specially named version that lets you evaluate the API before it becomes generally available. Opt in by sending:

X-Version: 2026-09-01.grc.preview

Important

Because this is a preview, it may receive breaking changes before GA. Notable changes are recorded in the changelog. Avoid depending on a preview for business-critical production workflows.

Forward compatibility#

Some fields carry a constrained set of known values (for example, a control’s significance or frequency) but are typed as open strings rather than fixed enumerations. New values may be introduced over time, so clients should tolerate values beyond those documented today rather than treating the set as closed.

Non-breaking vs. breaking changes#

Additive changes may ship to a version in place and should not break active integrations — for example, adding a new endpoint, a new optional field in a response, a new optional query parameter, or a new value to an open string field.

Breaking changes ship only in a new version — for example, removing or renaming endpoints, resources, parameters, or response fields; changing a field’s type; or changing authentication or authorization requirements.

Referencing a version#

curl -H "X-Version: 2026-09-01.grc.preview" \
     -H "Authorization: Bearer {access-token}" \
     -H "Wk-Workspace: {workspace-id}" \
     https://api.app.wdesk.com/controls