Scripting API Preview

The Scripting API allows users to manage scripts within Workiva. Scripts are automated programs that can be run to perform operations on Workiva data and documents.

• Scripts: A script is an automated program that can be configured, executed, and managed via the API. Scripts support dependency management, source file management, and permission controls.

• Script Runs: A script run represents a single execution of a script. Runs can be monitored, cancelled, and their logs and output can be downloaded.

• Script Sources: Source files are the code files that make up a script. The API supports uploading, downloading, and syncing source content.

• Script Permissions: Scripts support fine-grained permission management, allowing you to control who has access to view or execute a script.

Endpoints

The Scripting API Preview provides endpoints for:

• Managing scripts: create, retrieve, and list scripts

• Managing script runs: start, cancel, and retrieve run status, logs, and output

• Managing script sources: list, upload, download, and export source files

• Managing script permissions: retrieve and modify who has access to a script

• Managing script dependencies: trigger dependency generation

Using This Preview

The Scripting API Preview is released as a new version of the Workiva API (see Versioning). To use this feature preview, include an X-Version header with the value 2026-09-01.scripting.preview on all requests. Then, fetch a bearer token using the POST /oauth2/token endpoint (see Authentication for details). You can then use that token to call any of the new endpoints documented in this API preview.

Preview Status

This API is a preview capability and may change before general availability. For preview terms, expectations, and lifecycle details, see API Previews at Workiva.