> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workiva

> How to set up the Workiva connector, plus the actions that are available.

![Workiva](https://stackone-logos.com/api/workiva/filled/svg)

Betav0.2.0[See changelog](https://docs.stackone.com/connectors/workiva/changelog.md)

[266 actions](#actions) · 1 auth method

IAM
Documents

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/workiva/guides/connector-profile/oauth-2-0.md)
>
> Uses OAuth 2.0 client credentials created for an API-enabled user in Workiva. Tokens expire after 10 minutes and are ref...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/workiva/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

activity:read

file:read

file:write

graph:read

graph:write

organization:read

organization:write

task:read

task:write

No scopes found

266 actions

ActionDescriptionRequired scopes

Retrieve A Single Activity`workiva_get_activity_by_id`

Retrieves an activity given its ID.

`activity:read`

Retrieve A List Of Activity Actions`workiva_get_activity_actions`

Retrieves a list of actions performed that may produce activities.

`activity:read`

Retrieve A Single Activity Action`workiva_get_activity_action_by_id`

Returns an action performed, given its ID Attention The Workiva Platform does not guarantee that actions taken in the pl...

`activity:read`

Retrieve A List Of Activities For An Organization`workiva_get_organization_activities`

Returns a paginated list of activities for a given organization.

`activity:read`

Retrieve A List Of Activities For A Workspace`workiva_get_organization_workspace_activities`

Returns a paginated list of activities for a given organization and workspace.

`activity:read`

Retrieve A List Of Organizations`workiva_get_organizations`

Returns a paginated list of organizations.

`organization:read`

Retrieve A Single Organization`workiva_get_organization_by_id`

Retrieves an organization given its ID

`organization:read`

Update A Single Organization`workiva_partially_update_organization_by_id`

Updates the properties of an organization.

`organization:write`

Retrieve Available Roles Within An Organization`workiva_get_organization_roles`

Retrieves available roles within an organization given its ID

`organization:read`

Retrieve Available Solutions Within An Organization`workiva_get_organization_solutions`

Retrieves available solutions within an organization given its ID

`organization:read`

Retrieve List Of An Organizations Users`workiva_get_organization_users`

Retrieve users in an organization.

`organization:read`

Create A New Organization User`workiva_create_organization_user`

Creates a new OrganizationUser resource

`organization:write`

Assign Existing User To Organization`workiva_assign_user_to_organization`

Assign an existing organization user to an organization

`organization:write`

Retrieve A Single User In An Organization`workiva_get_organization_user_by_id`

Retrieves an organization user given its ID

`organization:read`

Partially Update A Single User In An Organization`workiva_partially_update_organization_user_by_id`

Partially update the properties of a User within an Organization.

`organization:write`

Delete An Organization User`workiva_delete_organization_user_by_id`

Delete a user from an organization

`organization:write`

List Roles Assigned To An Organization User`workiva_get_organization_user_role_list`

Retrieve a User's roles within an Organization

`organization:read`

Assign Roles For An Organization User`workiva_assign_organization_user_roles`

Assign a User's roles within an Organization.

`organization:write`

Revoke Roles For An Organization User`workiva_revoke_organization_user_roles`

Revoke a User's roles within an Organization.

`organization:write`

Retrieve List Of Workspaces`workiva_get_workspaces`

Retrieve a list of workspaces in an organization.

`organization:read`

Create A New Workspace`workiva_create_workspace`

Creates a new workspace resource

`organization:write`

Retrieve A Single Workspace`workiva_get_workspace_by_id`

Retrieves a workspace given its ID

`organization:read`

Update A Single Workspace`workiva_partially_update_workspace_by_id`

Updates the properties of a workspace.

`organization:write`

Retrieve List Of Groups`workiva_get_workspace_groups`

Retrieve a list of groups in a workspace

`organization:read`

Create A New Group In A Workspace`workiva_create_workspace_group`

Creates a new group resource

`organization:write`

Retrieve A Single Group`workiva_get_workspace_group_by_id`

Retrieves a group given its ID

`organization:read`

Update A Single Group`workiva_partially_update_workspace_group_by_id`

Updates the properties of a group.

`organization:write`

Delete A Single Group`workiva_delete_workspace_group_by_id`

Deletes a group given its ID.

`organization:write`

Retrieve List Of Group Members`workiva_get_workspace_group_members`

Retrieve a list of members in a workspace group

`organization:read`

Modify Members In A Group`workiva_modify_workspace_group_members`

Add and/or remove members from a group.

`organization:write`

Retrieve List Of Workspace Memberships`workiva_get_workspace_memberships`

Retrieve all memberships of a workspace

`organization:read`

Create A New Workspace Membership`workiva_create_workspace_membership`

Creates a new `WorkspaceMembership` resource

`organization:write`

Create A New Workspace Membership With Options`workiva_workspace_membership_creation_with_options`

Creates a new `WorkspaceMembership` and allows control over notification options.

`organization:write`

Retrieve A Single Workspace Membership`workiva_get_workspace_membership_by_id`

Retrieves a workspace membership given its ID

`organization:read`

Delete A Workspace Membership`workiva_delete_workspace_membership_by_id`

Revoke a user's membership to a `Workspace`.

`organization:write`

Retrieve Available Roles For A Workspace Membership`workiva_get_organization_workspace_membership_roles`

Retrieves available roles for a workspace membership

`organization:read`

Assign Roles For A Workspace Membership`workiva_assign_workspace_membership_roles`

Assign a member's roles within a Workspace.

`organization:write`

Revoke Roles For A Workspace Membership`workiva_revoke_workspace_membership_roles`

Revoke a member's roles within a Workspace.

`organization:write`

Retrieve Available Roles Within A Workspace`workiva_get_organization_workspace_roles`

Retrieves available roles within a workspace given an organization and workspace ID

`organization:read`

Retrieve Available Solutions Within A Workspace`workiva_get_workspace_solutions`

Retrieves available solutions within a workspace given its ID

`organization:read`

Retrieve A Solution By Id`workiva_get_workspace_solutions_by_id`

Retrieve a solutions within a workspace given its ID

`organization:read`

Retrieve An Anchor By ID`workiva_get_anchor_by_id`

Returns an `Anchor` given its id.

`file:read`

Retrieve A Destination Link By Id`workiva_get_destination_link_by_id`

Returns a `DestinationLink` given its id

`file:read`

Initiate A Destination Link Conversion`workiva_destination_link_source_conversion`

Converts a destination link into a source link.

`file:write`

Retrieve Drawing Elements By Id`workiva_get_drawing_elements_by_id`

Returns a `DrawingElementListResult` given its id

`file:read`

Retrieve A List Of Drawing Anchors`workiva_get_drawing_anchors`

Returns an `AnchorsListResult` for a given drawingId.

`file:read`

Retrieve A Drawing Anchor By ID`workiva_get_drawing_anchor_by_id`

Returns an `Anchor` given its id.

`file:read`

Retrieve A List Of Drawing Anchor Extensions`workiva_get_drawing_anchor_extensions`

Returns a paginated list of `AnchorExtensions` for a given anchorId.

`file:read`

Initiate Upload Of An Image`workiva_image_upload`

Retrieves a URL that can be used to upload an image, and an operationId to track the image upload progress.

`file:write`

Retrieve An Image By Id`workiva_get_image_by_id`

Returns a `Image` given its id

`file:read`

Retrieve A List Of Rich Text Anchors`workiva_get_rich_text_anchors`

Returns an `AnchorsListResult` for a given richTextId.

`file:read`

Initiate Creation Of A New Rich Text Anchor`workiva_rich_text_anchor_creation`

Create a new `Anchor` using a `RichTextAnchorCreation` request.

`file:write`

Retrieve A Rich Text Anchor By Id`workiva_get_rich_text_anchor_by_id`

Returns an `Anchor` given its id.

`file:read`

Retrieve A List Of Rich Text Anchor Extensions`workiva_get_rich_text_anchor_extensions`

Returns a paginated list of `AnchorExtensions` for a given anchorId.

`file:read`

Initiate Duplication Edits To Rich Text`workiva_rich_text_duplication_edit`

Sends a `RichTextDuplicationEdit` to perform on the rich text.

`file:write`

Initiate Edits To Rich Text`workiva_rich_text_batch_edit`

Sends a `RichTextBatchEdit` to perform as a batch on the rich text.

`file:write`

Initiate Edits To Rich Text Links`workiva_rich_text_links_batch_edit`

Sends a `RichTextLinksBatchEdit` to perform as a batch on the rich text.

`file:write`

Retrieve Rich Text Paragraphs`workiva_get_rich_text_paragraphs`

Returns a `ParagraphsListResult` for a rich text object, given its id.

`file:read`

Retrieve A Style Guide By Id`workiva_get_style_guide_by_id`

Returns the `StyleGuide` populated with the text styles, list styles, etc.

`file:read`

Initiate A Style Guide Export`workiva_style_guide_export`

Export the style guide with the given identifier.

`file:read`

Initiate Import Of A Style Guide`workiva_style_guide_import`

Imports a style guide to the given identifier.

`file:write`

Retrieve A List Of Table Anchors`workiva_get_table_anchors`

Returns an `AnchorsListResult` given tableId.

`file:read`

Initiate Creation Of A New Table Anchor`workiva_table_anchor_creation`

Create a new `Anchor` using a `TableAnchorCreation` request.

`file:write`

Retrieve A Table Anchor By ID`workiva_get_table_anchor_by_id`

Returns an `Anchor` given its id.

`file:read`

Retrieve A List Of Table Anchor Extensions`workiva_get_table_anchor_extensions`

Returns a paginated list of `AnchorExtensions` for a given anchorId.

`file:read`

Retrieve Table Cell Content`workiva_get_table_cells`

Returns a `TableCellsResult` for a given tableId.

`file:read`

Initiate Edits To Table Cells`workiva_table_cells_batch_edit`

Sends a `TableCellsBatchEdit` to perform on the cells in a table.

`file:write`

Retrieve Table Column Properties`workiva_get_column_properties`

Returns a `ColumnPropertiesListResult` for a table

`file:read`

Initiate Edit To A Table`workiva_table_edit`

Sends a single `TableEdit` to perform on the table.

`file:write`

Reapply Filters To The Table`workiva_table_filters_reapplication`

Performs a `TableFiltersReapplication` on the specified table.

`file:write`

Initiate Edit To Table Links`workiva_table_links_batch_edit`

Sends a `TableLinksBatchEdit` to perform on the links in a table.

`file:write`

Retrieve A List Of Range Links`workiva_get_range_links`

Returns a `RangeLinkListResult` for a given tableId.

`file:read`

Retrieve A Range Link By Id`workiva_get_range_link_by_id`

Returns a `RangeLink` given its id

`file:read`

Retrieve Range Link Destinations For A Source`workiva_get_range_link_destinations`

Returns a `RangeLinkListResult` of destinations for a given source range link.

`file:read`

Initiate Range Links Edits On A Table`workiva_table_range_links_edit`

Sends a `RangeLinkEdit` to perform on the range links in a table.

`file:write`

Retrieve A Table's Properties By Id`workiva_get_table_properties`

Returns a `TableProperties` for a table

`file:read`

Partially Update A Table's Properties`workiva_partially_update_table_properties`

Partially updates a table's properties given its ID.

`file:write`

Retrieve Table Row Properties`workiva_get_row_properties`

Returns a `RowPropertiesListResult` for a table

`file:read`

Retrieve A CustomSchema`workiva_get_custom_schema`

Retrieves the CustomSchema, which has the complete schema of custom fields and groups for the entire workspace, optional...

`file:read`

Partially Update A CustomSchema`workiva_partially_update_custom_schema`

Partially update the schema of custom fields and custom field groups for the entire workspace.

`file:write`

Retrieve A List Of Documents`workiva_get_documents`

Returns a paginated list of documents.

`file:read`

Retrieve A Single Document`workiva_get_document_by_id`

Retrieves a document given its ID.

`file:read`

Partially Update A Single Document`workiva_partially_update_document_by_id`

Updates the properties of a document.

`file:write`

Retrieve A Paginated Collection Of Bookmarks From A Document`workiva_get_bookmark_collection`

Returns bookmarks within a document in document order.

`file:read`

Apply A Batch Of Bookmark Edits To A Document`workiva_edit_bookmarks`

Sends a collection of bookmark edits to perform atomically on a document.

`file:write`

Retrieve A Single Bookmark From A Document`workiva_get_bookmark`

Returns the bookmark with the given ID from the document.

`file:read`

Initiate A Document Export`workiva_document_export`

Asynchronously exports a document as .PDF or .DOCX., or .XHTML.

`file:read`

Reapply Filters To The Document`workiva_document_filters_reapplication`

Performs a `DocumentFiltersReapplication` on the specified document.

`file:write`

Replace Link Destinations In A Document`workiva_document_links_destination_replacement`

Replaces existing link destinations with new destinations.

`file:write`

Initiate Publication Of Links In A Document`workiva_document_links_publication`

Publishes the links in a document - either all (as document owner) or only one's own.

`file:write`

Retrieve A List Of Milestones For A Document`workiva_get_document_milestones`

Returns MilestoneListResult.

`file:read`

Retrieve Permissions For A Document`workiva_get_document_permissions`

Retrieves a paginated list of permissions for a given document

`file:read`

Modify Permissions On A Document`workiva_document_permissions_modification`

Assign and/or revoke permissions on a document.

`file:write`

Retrieve A List Of Sections`workiva_get_sections`

Returns a list of sections.

`file:read`

Create A New Section In A Document`workiva_create_section`

Creates a new section in a document, given its properties.

`file:write`

Retrieve A Single Section`workiva_get_section_by_id`

Retrieves a section given its ID.

`file:read`

Partially Update A Single Section`workiva_partially_update_section_by_id`

Updates the properties of a section.

`file:write`

Delete A Single Section`workiva_delete_section_by_id`

Deletes a section given its ID.

`file:write`

Copy Section`workiva_copy_section`

Asynchronously copies a section given details about the copy's destination within the same or another document.

`file:write`

Initiate Sections Edits`workiva_edit_sections`

Updates the properties of a collection of sections in a document using SectionsEdits request.

`file:write`

Retrieve Permissions For A Section In A Document`workiva_get_section_permissions`

Retrieves a paginated list of permissions for the given section in a document

`file:read`

Modify Permissions On A Given Section Of A Document`workiva_section_permissions_modification`

Assign and/or revoke permissions on a section.

`file:write`

Retrieve A Collection Of Tables From A Document`workiva_get_document_table_collection`

Returns the collection of tables within a document.

`file:read`

Retrieve A List Of Files`workiva_get_files`

Returns a paginated list of files.

`file:read`

Create A New File`workiva_create_file`

Creates a new file.

`file:write`

Initiate A File Import`workiva_import_file`

Import a file for conversion to a Workiva equivalent.

`file:write`

Retrieve A List Of Trashed Files`workiva_get_trashed_files`

Returns a paginated list of files that have been trashed.

`file:read`

Retrieve A Single File`workiva_get_file_by_id`

Retrieves a file given its ID

`file:read`

Partially Update A Single File`workiva_partially_update_file_by_id`

Partially updates the properties of a file.

`file:write`

Initiate A File Copy`workiva_copy_file`

Copy a file to a new location.

`file:write`

Initiate A File Export By ID`workiva_export_file_by_id`

Export a file by its unique ID.

`file:write`

Initiate Restoration Of A Single File`workiva_restore_file_by_id`

Restores a file given its ID.

`file:write`

Initiate Trash Of A Single File`workiva_trash_file_by_id`

Trashes a file given its ID.

`file:write`

Retrieve Permissions For A File`workiva_get_file_permissions`

Retrieves a paginated list of permissions for a given file

`file:read`

Modify Permissions On A File`workiva_file_permissions_modification`

Assign and/or revoke permissions on a file.

`file:write`

Create New Record Edits`workiva_create_edits`

Creates new record edits given their properties.

`graph:write`

Retrieve A List Of Records`workiva_get_records`

Returns a list of records matching the provided filters.

`graph:read`

Retrieve A Single Record`workiva_get_record_by_id`

Retrieves a record given its ID.

`graph:read`

Initiate A Graph Report Export`workiva_graph_report_export`

Asynchronously exports a graph report (only CSV available at this time).

`graph:read`

Retrieve A List Of Types`workiva_get_types`

The Types endpoint is used to discover what types of records exist and their attributes.

`graph:read`

Retrieve A Single Type`workiva_get_type_by_id`

Returns a record type given its ID (name)

`graph:read`

Initiates A Request To Create A New Milestone`workiva_milestone_creation`

Create a new `Milestone` using a `MilestoneCreation` request.

`file:write`

Retrieve A Milestone By Id`workiva_get_milestone_by_id`

Returns a `Milestone` given its id

`file:read`

Partially Updates A Milestone`workiva_partially_update_milestone_by_id`

Partially updates a `Milestone` with a given id.

`file:write`

Deletes A Milestone`workiva_delete_milestone_by_id`

Deletes the `Milestone` with a given id.

`file:write`

Retrieve A Single Operation`workiva_get_operation_by_id`

Retrieves an operation given its ID.

Retrieve Copy File Results For A Single Operation`workiva_get_copy_file_results`

Returns a `CopyFileListResult` describing the results of a file copy operation.

`file:read`

Retrieves The Results From A Destination Link Source Conversion.`workiva_get_destination_link_source_conversion_results`

Returns the results for a destination link source conversion.

`file:read`

Retrieve Results For An Image Upload`workiva_get_image_upload_creation_results`

Returns an `ImageUploadResultCollection` describing the results of an image upload.

`file:read`

Retrieve Import File Results For A Single Operation`workiva_get_import_file_results`

Returns a `ImportFileListResult` describing the results of a file import operation.

`file:read`

Retrieve The Results Of A Metric Values Batch Upsertion Operation`workiva_get_batch_upsertion_metric_values_results`

Returns a `MetricValuesListResult` describing the results of a metric values batch upsertion operation.

`file:read`

Retrieve Results For A Milestone Creation`workiva_get_milestone_creation_results`

Returns a `MilestoneCreationListResult` describing the results of a milestone creation.

`file:read`

Retrieve Results For A Patch Document`workiva_get_patch_document_results`

Returns a `PatchDocumentListResult` describing the results of a patch document.

`file:read`

Retrieve Results For A Patch Presentation`workiva_get_patch_presentation_results`

Returns a `PatchPresentationListResult` describing the results of a patch presentation.

`file:read`

Retrieve Results For A Patch Section`workiva_get_patch_section_results`

Returns a `PatchSectionListResult` describing the results of a patch section.

`file:read`

Retrieve Results For A Patch Sheet`workiva_get_patch_sheet_results`

Returns a `PatchSheetListResult` describing the results of a patch sheet.

`file:read`

Retrieve Results For A Patch Slide Layout`workiva_get_patch_slide_layout_results`

Returns a `PatchSlideLayoutListResult` describing the results of a patch slide layout.

`file:read`

Retrieve Results For A Patch Slide`workiva_get_patch_slide_results`

Returns a `PatchSlideListResult` describing the results of a patch slide.

`file:read`

Retrieve Results For A Patch Spreadsheet`workiva_get_patch_spreadsheet_results`

Returns a `PatchSpreadsheetListResult` describing the results of a patch spreadsheet.

`file:read`

Retrieve Results For A Patch Table Properties`workiva_get_patch_table_properties_results`

Returns a `PatchTablePropertiesListResult` describing the results of a patch table properties.

`file:read`

Retrieve Results For A Range Link Edit`workiva_get_range_link_edit_results`

Returns a `RangeLinkEditResultCollection` describing the results of a range link edit.

`file:read`

Retrieve Results For A Rich Text Batch Edit`workiva_get_rich_text_batch_edit_results`

Returns a `RichTextEditListResult` describing the results of a rich text batch edit.

`file:read`

Retrieve Results For A Rich Text Anchor Creation`workiva_get_rich_text_anchor_creation_results`

Returns a `RichTextAnchorCreationResultCollection` describing the results of a rich text anchor creation.

`file:read`

Retrieve Results For A Rich Text Duplication Edit`workiva_get_rich_text_duplication_edit_results`

Returns a `RichTextDuplicationEditListResult` describing the results of a rich text duplication edit.

`file:read`

Retrieve Results For A Rich Text Links Batch Edit`workiva_get_rich_text_links_batch_edit_results`

Returns a `RichTextLinksEditListResult` describing the results of a rich text batch edit.

`file:read`

Retrieve Results For A Table Anchor Creation`workiva_get_table_anchor_creation_results`

Returns a `TableAnchorCreationResultCollection` describing the results of a table anchor creation.

`file:read`

Retrieve Results For A Table Cell Edit`workiva_get_table_cell_edit_results`

Returns a `TableCellEditListResult` describing the results of a table cell edit.

`file:read`

Retrieve Results For A Table Edit`workiva_get_table_edit_results`

Returns a `TableEditListResult` describing the results of a table edit.

`file:read`

Retrieve Results For A Table Links Edit`workiva_get_table_links_edit_results`

Returns a `TableLinksEditListResult` describing the results of a table links edit.

`file:read`

Retrieve Results For A Table Reapply Filter`workiva_get_table_reapply_filter_results`

Returns a `TableReapplyFilterListResult` describing the results of a table reapply filter.

`file:read`

Retrieve A List Of All Available Permissions`workiva_get_permissions`

Returns a list of permissions.

`file:read`

Retrieve A Single Permission`workiva_get_permission_by_id`

Retrieves a permission given its ID

`file:read`

Retrieve A Single Presentation`workiva_get_presentation_by_id`

Retrieves a presentation given its ID.

`file:read`

Partially Updates A Single Presentation`workiva_partially_update_presentation_by_id`

Updates the properties of a presentation.

`file:write`

Initiate A Presentation Export`workiva_presentation_export`

Asynchronously export a presentation as .PDF or .PPTX.

`file:read`

Reapply Filters To The Presentation`workiva_presentation_filters_reapplication`

Performs a `PresentationFiltersReapplication` on the specified presentation.

`file:write`

Replace Link Destinations In A Presentation`workiva_presentation_links_destination_replacement`

Replaces existing link destinations with new destinations.

`file:write`

Initiate Publication Of Links In A Presentation`workiva_presentation_links_publication`

Publishes the links in a presentation - either all (as document owner) or only one's own.

`file:write`

Retrieve A List Of Milestones For A Presentation`workiva_get_presentation_milestones`

Returns MilestoneListResult.

`file:read`

Retrieve Permissions For A Presentation`workiva_get_presentation_permissions`

Retrieves a paginated list of permissions for a given presentation

`file:read`

Modify Permissions On A Presentation`workiva_presentation_permissions_modification`

Assign and/or revoke permissions on a presentation.

`file:write`

Retrieve A List Of Slide Layouts`workiva_get_slide_layouts`

Returns a list of slide layouts.

`file:read`

Retrieve A Single Slide Layout`workiva_get_slide_layout_by_id`

Retrieves a slide layout given its ID.

`file:read`

Partially Update A Single Slide Layout`workiva_partially_update_slide_layout_by_id`

Updates one or more properties of a single slide layout.

`file:write`

Retrieve A List Of Slides`workiva_get_slides`

Returns a list of slides.

`file:read`

Retrieve A Single Slide`workiva_get_slide_by_id`

Retrieves a slide given its ID.

`file:read`

Partially Update A Single Slide`workiva_partially_update_slide_by_id`

Updates one or more properties of a single slide.

`file:write`

Retrieve Permissions For A Slide In A Presentation`workiva_get_slide_permissions`

Retrieves a paginated list of permissions for the given slide in a presentation

`file:read`

Modify Permissions On A Given Slide Of A Presentation`workiva_slide_permissions_modification`

Assign and/or revoke permissions on a slide.

`file:write`

Retrieve A Collection Of Tables From A Presentation`workiva_get_presentation_table_collection`

Returns the collection of tables within a presentation.

`file:read`

Retrieve A ProcessRun By ID`workiva_get_process_run`

Retrieve a ProcessRun (running instance of a process) by its unique identifier.

`file:read`

Retrieve A List Of Processes`workiva_list_processes`

Retrieve a paginated list of processes the caller has access to, with each process's associated ProcessRun embedded (if...

`file:read`

Create A Process`workiva_create_process`

Create a new process with the specified configuration and job hierarchy.

`file:write`

Retrieve A Process By ID`workiva_get_process`

Retrieve a process by its id.

`file:read`

Partially Update A Process`workiva_partially_update_process_by_id`

Updates the properties of a process via JSON Patch.

`file:write`

Bulk Update Group And Job Names`workiva_batch_update_process`

Updates names for specified jobs and groups.

`file:write`

Run A Process`workiva_run_process`

Run an existing process by its id, creating a new ProcessRun.

`file:write`

Validate A Process`workiva_validate_process`

Run a validation check on a process and return any structural or configuration errors found.

`file:read`

List Organization Users`workiva_get_org_report_users`

Similar to an organization admin's "People View" export, this returns a paged list of specific details about the organiz...

`organization:read`

Retrieve A List Of Spreadsheets`workiva_get_spreadsheets`

Returns a paginated list of spreadsheets.

`file:read`

Retrieve A Single Spreadsheet`workiva_get_spreadsheet_by_id`

Retrieves a spreadsheet given its ID.

`file:read`

Partially Update A Single Spreadsheet`workiva_partially_update_spreadsheet_by_id`

Updates the properties of a spreadsheet.

`file:write`

Retrieve A List Of Datasets`workiva_get_datasets`

Returns a list of datasets.

`file:read`

Bulk Upsert Of Datasets`workiva_upsert_datasets`

Asynchronously upserts an array of datasets to a spreadsheet, given their properties.

`file:write`

Initiate A Spreadsheet Export`workiva_spreadsheet_export`

Asynchronously exports a spreadsheet as .XLSX, .PDF, or .CSV.

`file:read`

Reapply Filters To The Spreadsheet`workiva_spreadsheet_filters_reapplication`

Performs a `SpreadsheetFiltersReapplication` on the specified spreadsheet.

`file:write`

Replace Link Destinations In A Spreadsheet`workiva_spreadsheet_links_destination_replacement`

Replaces existing link destinations with new destinations.

`file:write`

Initiate Publication Of Links In A Spreadsheet`workiva_spreadsheet_links_publication`

Publishes the links in a spreadsheet - either all (as document owner) or only one's own.

`file:write`

Retrieve A List Of Milestones For A Spreadsheet`workiva_get_spreadsheet_milestones`

Returns MilestoneListResult.

`file:read`

Retrieve Permissions For A Spreadsheet`workiva_get_spreadsheet_permissions`

Retrieves a paginated list of permissions for a given spreadsheet

`file:read`

Modify Permissions On A Spreadsheet`workiva_spreadsheet_permissions_modification`

Assign and/or revoke permissions on a spreadsheet.

`file:write`

Retrieve A List Of Sheets`workiva_get_sheets`

Returns a list of sheets.

`file:read`

Create A New Sheet In A Spreadsheet`workiva_create_sheet`

Creates a new sheet in a spreadsheet, given its properties.

`file:write`

Retrieve A Single Sheet`workiva_get_sheet_by_id`

Retrieves a sheet given its ID.

`file:read`

Partially Update A Single Sheet`workiva_partially_update_sheet_by_id`

Updates the properties of a sheet.

`file:write`

Delete A Single Sheet`workiva_delete_sheet_by_id`

Deletes a sheet given its ID.

`file:write`

Copy Sheet`workiva_copy_sheet`

Asynchronously copies a sheet given details about the copy's destination within the same or another spreadsheet.

`file:write`

Delete A Single Dataset`workiva_delete_dataset_by_sheet_id`

Deletes the dataset for the specified sheet.

`file:write`

Retrieve Permissions For A Sheet In A Spreadsheet`workiva_get_sheet_permissions`

Retrieves a paginated list of permissions for the given sheet in a spreadsheet

`file:read`

Modify Permissions On A Given Sheet Of A Spreadsheet`workiva_sheet_permissions_modification`

Assign and/or revoke permissions on a sheet.

`file:write`

Retrieve Data From A Sheet`workiva_get_sheet_data`

Retrieve data from a range in a sheet.

`file:read`

Update Sheet Content`workiva_update_sheet`

Asynchronously submits a SheetUpdate to a sheet.

`file:write`

Retrieve A List Of Range Values`workiva_get_values_by_range`

Returns the paginated values for a specified range.

`file:read`

Update Values In A Range`workiva_update_values_by_range`

Overwrites all values in a range with new values.

`file:write`

Retrieve A List Of Programs`workiva_get_programs`

Returns a paginated list of programs.

`file:read`

Create A New Program`workiva_create_program`

Creates a new program.

`file:write`

Retrieve A Single Program`workiva_get_program_by_id`

Retrieves a program given its ID

`file:read`

Partially Update A Single Program`workiva_partially_update_program_by_id`

Partially updates the properties of a program.

`file:write`

Retrieve A List Of Dimensions`workiva_get_dimensions`

Returns a paginated list of dimensions.

`file:read`

Create A New Dimension`workiva_create_dimension`

Creates a new dimension.

`file:write`

Retrieve A Single Dimension`workiva_get_dimension_by_id`

Retrieves a dimension given its ID

`file:read`

Partially Update A Single Dimension`workiva_partially_update_dimension_by_id`

Partially updates the properties of a dimension.

`file:write`

Retrieve A List Of Metrics`workiva_get_metrics`

Returns a paginated list of Metrics.

`file:read`

Create A New Metric`workiva_create_metric`

Creates a new metric.

`file:write`

Retrieve A Single Metric`workiva_get_metric_by_id`

Retrieves a `Metric` given its ID

`file:read`

Partially Update A Single Metric`workiva_partially_update_metric_by_id`

Partially updates the properties of a metric.

`file:write`

Delete A Single Metric`workiva_delete_metric_by_id`

Deletes a metric given its ID

`file:write`

Retrieve A List Of Metric Values`workiva_get_values`

Returns a paginated list of metric Values

`file:read`

Create A New Metric Value`workiva_create_value`

Creates a new metric value

`file:write`

Retrieve A Single Metric Value`workiva_get_metric_value_by_id`

Retrieves a metric value given its ID

`file:read`

Partially Update A Single Metric Value`workiva_partially_update_metric_value_by_id`

Partially updates the properties of a metric value.

`file:write`

Delete A Single Metric Value`workiva_delete_metric_value_by_id`

Deletes a metric value given its ID

`file:write`

Initiate A Batch Deletion Of Metric Values`workiva_batch_deletion_metric_values`

Batch delete the given metric values.

`file:write`

Initiate A Batch Upsertion Of Metric Values`workiva_batch_upsertion_metric_values`

Batch upsert values for the given metric.

`file:write`

Retrieve Permissions For A Program`workiva_get_program_permissions`

Retrieves a paginated list of permissions for a given Sustainability Program

`file:read`

Modify Permissions On A Program`workiva_program_permissions_modification`

Assign and/or revoke permissions on a Sustainability Program.

`file:write`

Retrieve A List Of Topics`workiva_get_topics`

Returns a paginated list of topics.

`file:read`

Create A New Topic`workiva_create_topic`

Creates a new topic.

`file:write`

Retrieve A Single Topic`workiva_get_topic_by_id`

Retrieves a topic given its ID

`file:read`

Partially Update A Single Topic`workiva_partially_update_topic_by_id`

Partially updates the properties of a topic.

`file:write`

Delete A Single Topic`workiva_delete_topic_by_id`

Deletes a topic given its ID

`file:write`

Retrieve A List Of Tasks`workiva_get_tasks`

Returns a paginated list of tasks.

`task:read`

Create A New Task`workiva_create_task`

Creates a new task given its properties.

`task:write`

Retrieve A Single Task`workiva_get_task_by_id`

Retrieves a task given its ID

`task:read`

Partially Update A Single Task`workiva_partially_update_task_by_id`

Partially updates the properties of a task.

`task:write`

Delete A Single Task`workiva_delete_task_by_id`

Deletes a task given its ID

`task:write`

Initiate A Task Action Submission`workiva_submit_task_action`

This endpoint enables submitting actions on a task.

`task:write`

Retrieve A List Of Test Forms`workiva_get_test_forms`

Retrieves a list of test forms.

`graph:read`

Retrieve A Single Test Form`workiva_get_test_form_by_id`

Retrieves a test form given its ID.

`graph:read`

Initiate A Test Form Export`workiva_test_form_export`

Asynchronously exports a test form.

`graph:read`

Retrieve A List Of Test Phases`workiva_get_test_phases`

Returns a list of test phases.

`graph:read`

Retrive A Single Test Phase`workiva_get_test_phase_by_id`

Retrieves a test phase given its ID.

`graph:read`

Initiate A Test Phase Attachment Upload`workiva_test_phase_attachment_upload`

Starts the process to upload and attach a file to a test phase using a graph attachment upload object.

`graph:write`

Retrieve A List Of Test Phase Attachments`workiva_get_test_phase_attachments`

Returns a list of attachments for a test phase.

`graph:read`

Retrieve A Single Test Phase Attachment`workiva_get_test_phase_attachment_by_id`

Retrieve a single attachment by its ID.

`graph:read`

Initiate A Test Phase Attachment Download`workiva_test_phase_attachment_download_by_id`

Asynchronously downloads an attachment from a test phase.

`graph:read`

Initiate A Test Phase Attachment Export`workiva_test_phase_attachment_export_by_id`

Asynchronously exports an attachment for a test phase to .PDF.

`graph:read`

Retrieve A List Of Matrices`workiva_get_matrices`

Returns a list of matrices.

`graph:read`

Create A New Matrix`workiva_create_matrix`

Create a new empty matrix.

`graph:write`

Retrieve A Single Matrix`workiva_get_matrix_by_id`

Retrieves a matrix given its ID.

`graph:read`

Initiate A Matrix Attachment Upload`workiva_matrix_attachment_upload`

Starts the process to upload and attach a file to a matrix using a graph attachment upload object.

`graph:write`

Retrieve A List Of Matrix Attachments`workiva_get_matrix_attachments`

Returns a list of attachments for a matrix.

`graph:read`

Retrieve A Single Matrix Attachment`workiva_get_matrix_attachment_by_id`

Retrieve a single attachment by its ID.

`graph:read`

Initiate A Matrix Attachment Download`workiva_matrix_attachment_download_by_id`

Asynchronously downloads an attachment from a matrix.

`graph:read`

Initiate An Export Of A Matrix Attachment`workiva_matrix_attachment_export_by_id`

Asynchronously exports an attachment for a matrix to .PDF.

`graph:read`

Retrieve A List Of Samples`workiva_get_samples`

Returns a list of samples.

`graph:read`

Create A New Sample`workiva_create_sample`

Create a new sample in a matrix.

`graph:write`

Insert Samples`workiva_sample_insertion`

Inserts multiple samples into a matrix, and appends new samples to the end of the matrix.

`graph:write`

Update Samples`workiva_sample_update`

Updates multiple samples, with the requestBody of each specifying columns to update by their IDs.

`graph:write`

Retrieve A Single Sample`workiva_get_sample_by_id`

Retrieves a sample given its ID.

`graph:read`

Partially Update A Single Sample`workiva_partially_update_sample_by_id`

Partially updates the properties of a sample.

`graph:write`

Initiate An Upload Of A Sample Attachment`workiva_sample_attachment_upload`

Starts the process to upload and attach a file to a sample using a graph attachment upload object.

`graph:write`

Retrieve A List Of Sample Attachments`workiva_get_sample_attachments`

Returns a list of attachments for a sample.

`graph:read`

Retrieve A Single Sample Attachment`workiva_get_sample_attachment_by_id`

Retrieve a single attachment by its ID.

`graph:read`

Initiate A Download Of A Sample Attachment`workiva_sample_attachment_download_by_id`

Asynchronously downloads an attachment from a sample.

`graph:read`

Initiate An Export Of A Sample Attachment`workiva_sample_attachment_export_by_id`

Asynchronously exports an attachment for a sample to .PDF.

`graph:read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.