Get Started with Workiva's APIs
Workiva offers many Application Programming Interfaces (APIs). An API is a set of protocols that allow for building software applications that access the features and data of an application or their service. APIs are commonly used by developers to integrate different software systems, allowing them to share data and functionality. APIs make it easier for developers to create new applications that can interact with existing systems. Workiva's APIs are free to use and span the Workiva Platform. They are routinely expanded upon and new endpoints are frequently added.
Many of the Workiva API endpoints have a corresponding dedicated Command available in the Workiva Connector. However, some API endpoints may not currently have a dedicated built-in Command in Chains. These endpoints can still be utilized within Chains using the HTTP Requests Connector.
Workiva uses a unified, date based versioning system to ensure stable and predictable integrations as the Platform evolves. Each API version is identified by a YYYY‑MM‑DD release date through the X‑Version header. For full details, see the Versioning, 2026-01-01 Upgrade Guide, and API Version Best Practices documentation.
Detailed documentation about API changes are provided in the Changelog.
Below are links to developer documentation for the API version 2026-01-01 offerings.
- https://developers.workiva.com
- The main landing page that links to the various API documentation
- Platform API
- Interact with core components of the Workiva platform including Documents, Files, Graph, Presentations, Spreadsheets, Tasks, Test Forms, and Users
- Sustainability API
- Manage Sustainability Programs
- Identify and Access Management (IAM) API
- Exchange your OAuth credentials (clientID and clientSecret) for a token
- Admin API
- Manage Workiva users, Organizations, and Workspaces
- Platform API
- Manage items in the Workiva platform
- Content API
- Reading and writing Workiva Content. See Introduction to Content Endpoints
- Milestones API
- Manage Milestones. See Introduction to Milestones Endpoints for more information
- Documents API
- Manage Documents and their sections in the Workiva Platform
- Files API
- Manage Files and Folders
- Graph API
- Pull Reports and Records, create and edit Records, and more in Integrated Risk workspaces. See Graph Guides for further documentation and examples
- Operations API
- Manage Operations
- Permissions API
- Manage Permissions
- Presentations API
- Manage Presentations
- Spreadsheets API
- Manage Spreadsheets and their Sheets
- Tasks API
- Create and manage Tasks
- Test Forms API
- Manage Test Forms, Test Phases, and Matrices. Also manage Attachments on Test Phases, Matrices, and Samples
- PlatformUsers API
- Manage Users
- Wdata API
- Connect, curate, and explore data within Wdata
- Chains API
- Manage chain runs, and retrieve metadata about your Workspace
- API version 2022-01-01
- Workiva recommends using version 2026-01-01
It is leading practice to include error handling and rate usage monitoring in your applications. If you do reach a limit, the Workiva APIs will respond with `429 Too Many Requests` status code. You can find information on the limits for each API in the "Limits" section of the API documentation. For example, you can find the Platform API Limits here. You are also encouraged to review the API Rate Limits documentation for more details.
Iniciar sesión para dejar un comentario.
Comentarios
0 comentarios