Skip to main content
Back to top
Ctrl
+
K
Workiva API Versions
Versions
2026-01-01
2022-01-01
Wdata API
Chains API
Search
Ctrl
+
K
2022-01-01
API Details
Setup
Authentication
Code Generation
Digests
Errors
Expansion
Filtering & Sorting
Headers
Limits
Pagination
PATCH Updates
Versioning
2026-01-01 Upgrade Guide
Legacy Spreadsheets API Migration Guide
Changelog
IAM
Retrieve a token
Admin
Activities
Retrieve a single activity
Retrieve a list of activity actions
Retrieve a single activity action
Retrieve a list of activities for an organization
Retrieve a list of activities for a workspace
Reports
List organization users
Platform
Documents
Retrieve a list of documents
Retrieve a single document
Initiate a document export
Retrieve a list of sections
Create a new section in a document
Delete a single section
Retrieve a single section
Partially update a single section
Update a single section
Copy section
Files
Retrieve a list of files
Create a new file
Initiate a file import
Retrieve a single file
Partially update a single file
Update a single file
Graph
Introduction to Graph Endpoints
Create a new record
Delete a single record
Update a single record
Create new record edits
Retrieve a list of records
Retrieve a single record
Retrieve the CSV of a saved report
Initiate a graph report export
Retrieve a list of types
Retrieve a single type
Operations
Retrieve a single operation
Presentations
Initiate a presentation export
PlatformSpreadsheets
Retrieve a list of spreadsheets
Retrieve a single spreadsheet
Retrieve a list of datasets
Bulk upsert of datasets
Initiate a spreadsheet export
Retrieve a list of sheets
Create a new sheet in a spreadsheet
Delete a single sheet
Retrieve a single sheet
Partially update a single sheet
Update a single sheet
Copy sheet
Delete a single dataset
Retrieve data from a sheet
Update sheet content
Retrieve a list of range values
Update values in a range
Tasks
Retrieve a list of tasks
Create a new task
Delete a single task
Retrieve a single task
Partially update a single task
Update a single task
Test Forms
Retrieve a list of test forms
Retrieve a single test form
Initiate a test form export
Retrieve a list of test phases
Retrive a single test phase
Initiate a test phase attachment upload
Retrieve a list of test phase attachments
Retrieve a single test phase attachment
Initiate a test phase attachment download
Initiate a test phase attachment export
Retrieve a list of matrices
Create a new matrix
Retrieve a single matrix
Initiate a matrix attachment upload
Retrieve a list of matrix attachments
Retrieve a single matrix attachment
Initiate a matrix attachment download
Initiate an export of a matrix attachment
Retrieve a list of samples
Create a new sample
Insert samples
Update samples
Retrieve a single sample
Partially update a single sample
Update a single sample
Initiate an upload of a sample attachment
Retrieve a list of sample attachments
Retrieve a single sample attachment
Initiate a download of a sample attachment
Initiate an export of a sample attachment
PlatformUsers
Retrieve a list of users
Prototype Admin
Admin
Retrieve a list of organizations
Retrieve a single organization
Update a single organization
Retrieve available roles within an organization
Retrieve available solutions within an organization
Retrieve list of an organizations users
Create a new organization User
Assign existing user to organization
Delete an organization user
Retrieve a single user in an organization
Partially update a single user in an organization
List Roles assigned to an Organization User
Assign roles for an Organization User
Revoke roles for an Organization User
Retrieve list of workspaces
Create a new workspace
Retrieve a single workspace
Update a single workspace
Retrieve list of groups
Create a new group in a workspace
Delete a single group
Retrieve a single group
Update a single group
Retrieve list of group members
Modify members in a group
Retrieve list of workspace memberships
Create a new workspace membership
Create a new workspace membership with options
Delete a workspace membership
Retrieve a single workspace membership
Retrieve available roles for a workspace membership
Assign roles for a Workspace Membership
Revoke roles for a Workspace Membership
Retrieve available roles within a workspace
Retrieve available solutions within a workspace
Retrieve a solution by id
Prototype Platform
Audits
Retrieve a list of audits
Retrieve a single audit
Initiate an audit attachment upload
Retrieve a list of audit attachments
Retrieve a single audit attachment
Initiate an audit attachment download
Initiate an audit attachment export
Initiate an audit export
Retrieve a list of procedures
Retrieve a single procedure
Initiate a procedure attachment upload
Retrieve a list of procedure attachments
Retrieve a single procedure attachment
Initiate a procedure attachment download
Initiate a procedure attachment export
Retrieve a list of matrices
Create a new matrix
Retrieve a single matrix
Initiate a matrix attachment upload
Retrieve a list of matrix attachments
Retrieve a single matrix attachment
Initiate a matrix attachment download
Initiate an export of a matrix attachment
Retrieve a list of samples
Create a new sample
Insert samples
Update samples
Retrieve a single sample
Partially update properties of a single sample
Update a single sample
Initiate an upload of a sample attachment
Retrieve a list of sample attachments
Retrieve a single sample attachment
Initiate a download of a sample attachment
Initiate an export of a sample attachment
Content
Introduction to Content Endpoints
Image
Initiate upload of an image
Retrieve an image by id
Rich Text
Initiate edits to rich text
Retrieve rich text paragraphs
Initiate duplication edits to rich text
Tables
Retrieve table cell content
Initiate edits to table cells
Retrieve table column properties
Initiate edit to a table
Reapply filters to the table
Retrieve table row properties
Retrieve a table’s properties by id
Partially update a table’s properties
Style Guides
Retrieve a style guide by id
Initiate a style guide export
Initiate import of a style guide
Anchors
Retrieve a list of drawing anchors
Retrieve a list of rich text anchors
Initiate creation of a new rich text anchor
Retrieve a rich text anchor by id
Retrieve a list of rich text anchor extensions
Retrieve an anchor by ID
Retrieve a list of table anchors
Initiate creation of a new table anchor
Retrieve a table anchor by ID
Retrieve a list of table anchor extensions
Drawings
Retrieve drawing elements by id
Retrieve a drawing anchor by ID
Retrieve a list of drawing anchor extensions
Links
Retrieve a destination link by id
Initiate a destination link conversion
Initiate edits to rich text links
Initiate edit to table links
Range Links
Retrieve a list of range links
Retrieve a range link by id
Retrieve range link destinations for a source
Initiate range links edits on a table
Custom Fields
Introduction to Custom Fields Endpoints
Retrieve a customSchema
Partially update a customSchema
Get Custom Fields
Create Custom Field
Get Custom Field
Update Custom Field
PrototypeDocuments
Retrieve a list of documents
Retrieve a single document
Update a single document
Reapply filters to the document
Initiate publication of links in a document
Retrieve a list of milestones for a document
Retrieve permissions for a document
Modify permissions on a document
Retrieve a list of sections
Create a new section in a document
Initiate sections edits
Delete a single section
Retrieve a single section
Partially update a single section
Update a single section
Retrieve permissions for a section in a document
Modify permissions on a given section of a document
PrototypeFiles
Retrieve a list of files
Create a new file
Initiate a file export
Initiate a file import
Retrieve a list of trashed files
Retrieve a single file
Partially update a single file
Update a single file
Initiate a file copy
Retrieve permissions for a file
Modify permissions on a file
Initiate restoration of a single file
Initiate trash of a single file
Initiate a file export by ID
PrototypeMilestones
Introduction to Milestones Endpoints
Retrieve a milestone by id
Deletes a milestone
Partially updates a milestone
Initiates a request to create a new milestone
PrototypeOperations
Introduction to Operations
Retrieve a single operation
Retrieve the results of a batch upsertion of metric values
Retrieve copy file results for a single operation
Retrieves the results from a destination link source conversion.
Retrieve results for a image upload
Retrieve import file results for a single operation
Retrieve results for a range link edit
Retrieve results for a rich text batch edit
Retrieve results for a rich text anchor creation
Retrieve results for a rich text links batch edit
Retrieve results for a table anchor creation
Retrieve results for a table cell edit
Retrieve results for a table edit
Retrieve results for a table links edit
Retrieve results for a table reapply filter
Retrieve results for a milestone creation
Retrieve results for a patch document
Retrieve results for a patch presentation
Retrieve results for a patch Section
Retrieve results for a patch sheet
Retrieve results for a patch slide layout
Retrieve results for a patch slide
Retrieve results for a patch spreadsheet
Retrieve results for a patch table properties
Retrieve results for a rich text duplication edit
Permissions
Introduction to Permissions Endpoints
Retrieve a list of all available permissions
Retrieve a single permission
PrototypePresentations
Retrieve a list of presentations
Retrieve a single presentation
Update a single presentation
Reapply filters to the presentation
Initiate publication of links in a presentation
Retrieve a list of milestones for a presentation
Retrieve permissions for a presentation
Modify permissions on a presentation
Retrieve a list of slide layouts
Create a new slide layout in a presentation
Delete a single slide layout
Retrieve a single slide layout
Partially update a single slide layout
Copy slide layout
Retrieve a list of slides
Create a new slide in a presentation
Delete a single slide
Retrieve a single slide
Partially update a single slide
Initiate a slide copy
Retrieve permissions for a slide in a presentation
Modify permissions on a given slide of a presentation
Sustainability
Retrieve a list of programs
Create a new program
Retrieve a single program
Partially update a single program
Retrieve a list of dimensions
Create a new dimension
Retrieve a single dimension
Partially update a single dimension
Retrieve a list of metrics
Create a new metric
Delete a single metric
Retrieve a single metric
Partially update a single metric
Retrieve a list of metric values
Create a new metric value
Initiate a batch deletion of metric values
Initiate a batch upsertion of metric values
Retrieve permissions for a program
Modify permissions on a program
Retrieve a list of topics
Create a new topic
Delete a single topic
Retrieve a single topic
Partially update a single topic
Delete a single metric value
Retrieve a single metric value
Partially update a single metric value
Scripts
Retrieve a list of scripts
Create a new script
Retrieve a single script
Partially update a single script
Initiate a script execution
Retrieve permissions for given script
Modify permissions on a script
Retrieve a list of runs
Retrieve a single run
Initiate a run cancellation
Initiate a download of run logs
Initiate a download of run output
Retrieve a list of sources
Create a new source
Delete a single source
Retrieve a single source
Partially update a single source
Initiate a content download
Initiate a content upload
PrototypeSpreadsheets
Retrieve a list of spreadsheets
Retrieve a single spreadsheet
Update a single spreadsheet
Reapply filters to the spreadsheet
Initiate publication of links in a spreadsheet
Retrieve a list of milestones for a spreadsheet
Retrieve permissions for a spreadsheet
Modify permissions on a spreadsheet
Retrieve a list of sheets
Retrieve a single sheet
Partially update a single sheet
Update a single sheet
Retrieve permissions for a sheet in a spreadsheet
Modify permissions on a given sheet of a spreadsheet
Update sheet content
PrototypeTasks
Retrieve a list of tasks
Create a new task
Delete a single task
Retrieve a single task
Partially update a single task
Initiate a task action submission
Legacy Spreadsheets
LegacySpreadsheetsAsync
Asynchronously write data to a region
Return job data for an asynchronous operation
LegacySpreadsheets
Create a new spreadsheet
Delete a spreadsheet
Return spreadsheet properties
Update spreadsheet properties
Publish links in a spreadsheet
Return a list of all sheets in the outline and their properties
Create a new sheet
Delete a sheet and all of its child sheets (recursively)
Return sheet properties
Update sheet properties
Return data from a region
Write data to a region
Additional Objects
Update a single record
Update a single record
#
Note
To update existing records, use the
edits
endpoint.
