Workiva

App · 25 actions

Work with your Workiva reporting and compliance files: list, copy, export and import files, read and write spreadsheet cells, mark milestones, manage and approve tasks, read the activity log and Integrated Risk records, and start workflows on new files, tasks and activity.

Actions

ActionWhat it does
Add a sheetAdd a sheet to a spreadsheet.
Approve, reject or submit a taskMove a task along its approval: submit it, approve or reject it, skip an approval step, restart it or cancel it.
Copy a fileCopy a file or folder, optionally into another folder and under a new name, and wait for Workiva to finish.
Create a file or folderCreate an empty document, spreadsheet, presentation or folder.
Create a milestoneMark the current version of a document, spreadsheet or presentation with a milestone, such as the version sent to the auditors.
Create a taskCreate a task, optionally on a file, with assignees, a due date and an approval step.
Delete a sheetDelete a sheet from a spreadsheet.
Delete a taskDelete a task.
Export a fileExport a document (PDF, Word or XHTML), spreadsheet (PDF, Excel or CSV) or presentation (PDF or PowerPoint) and save the file, ready to attach or upload in a later step.
Get a fileGet one file or folder: its name, kind, folder and when it last changed.
Get a taskGet one task with its status, assignees and approval steps.
Get an operationCheck on a long-running Workiva operation, such as a copy, export or import that was still running when its step stopped waiting.
Import a fileUpload a file to Workiva: an Excel or CSV file becomes a spreadsheet, a Word file a document, a PowerPoint or Visio file a presentation, or keep any file as a supporting document.
List activitiesList what was done in your Workiva organization, or one workspace, newest first: sign-ins, users added, roles and settings changed.
List filesList the files and folders the connection's Workiva user can open, most recently changed first, optionally of one kind or in one folder.
List milestonesList the milestones of a document, spreadsheet or presentation.
List record typesList the kinds of Integrated Risk records your workspaces keep (such as controls, risks and issues) and the properties each has.
List recordsList Integrated Risk records of one type, such as every control or issue, or get one by its ID.
List sheetsList the sheets of a spreadsheet.
List tasksList tasks, most recently changed first, by assignee, file, title, due date or when they changed.
List usersList the people in your Workiva organization, with the IDs tasks and filters use.
Move a file to the trashMove a file or folder to the trash (a folder with everything in it).
Read cellsRead the values in a range of a sheet, row by row.
Update a taskChange a task's title, description, due date or assignees.
Write cellsWrite values into a range of a sheet, replacing what is there, and wait for Workiva to finish.

Add a sheet

Add a sheet to a spreadsheet. Workiva adds a number to a name already used.

Inputs

Spreadsheetspreadsheet_idtextRequired
The spreadsheet. Pick one, or give its file ID from an earlier step.
NamenametextRequired
The sheet's name.
Positionpositionnumber
Where to put it, 1 for first. Leave empty to add it last.From 1 to 10000.

Outputs

sheetobject
The new sheet
sheet_idtext
The new sheet's ID
Example output
{
  "sheet": {
    "id": "242a56d3cc0742c8abad0820bd318b23",
    "index": 0,
    "lock": null,
    "name": "Cash",
    "revision": "2B3C4D5E"
  },
  "sheet_id": "242a56d3cc0742c8abad0820bd318b23"
}

Approve, reject or submit a task

Move a task along its approval: submit it, approve or reject it, skip an approval step, restart it or cancel it. The connection's Workiva user must be allowed to take that action on the task.

Inputs

Task IDtask_idtextRequired
The task's ID, from 'List tasks', 'Create a task' or a task trigger.
Actiontask_actiontextRequired
What to do.One of: SUBMIT (Submit for approval), APPROVE, REJECT, SKIP (Skip this approval step), RESTART, CANCEL.
Commentcommenttext
A comment to go with it.

Outputs

taskobject
The task
task_idtext
The task's ID
Example output
{
  "task": {
    "approvalSteps": [
      {
        "completionMode": "ONE",
        "dueDate": null,
        "participants": [
          {
            "id": "V0ZVc2VyHzY0MTI5NzM0MzkxODg5OTI",
            "type": "USER"
          }
        ],
        "responses": []
      }
    ],
    "assignees": [
      {
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "type": "USER"
      }
    ],
    "created": {
      "dateTime": "2026-10-28T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "description": "Tie the cash balance to the bank statement",
    "dueAt": "2026-11-15T00:00:00Z",
    "dueDate": "2026-11-15T00:00:00Z",
    "id": "129g274495354cf18edb6b3ea3d023b2",
    "location": {
      "resource": "8bd6ec9d30684550b6f6ac30e764cd22",
      "segment": null
    },
    "modified": {
      "dateTime": "2026-10-29T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "owner": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
    "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQ",
    "status": "Awaiting Approval",
    "title": "Review cash tie-out"
  },
  "task_id": "129g274495354cf18edb6b3ea3d023b2"
}

Copy a file

Copy a file or folder, optionally into another folder and under a new name, and wait for Workiva to finish.

Inputs

Filefile_idtextRequired
The file or folder. Pick one, or give a file ID from an earlier step.
Copy intofolder_idtext
The folder to copy into. Leave empty for the top level.
New namenew_nametext
The copy's name. Leave empty to keep the name.
Keep commentsinclude_commentstrue/false
Copy the comments too.
Keep attachmentsinclude_attachmentstrue/false
Copy the attachments too.

Outputs

file_idtext
The copy's file ID
fileslist
Every file the copy made
operation_idtext
The Workiva operation that did the work, for 'Get an operation'
statustext
The operation's final status
Example output
{
  "file_id": "5a3c2b1d0e9f48a7b6c5d4e3f2a1b0c9",
  "files": [
    {
      "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
      "id": "5a3c2b1d0e9f48a7b6c5d4e3f2a1b0c9",
      "kind": "Document"
    }
  ],
  "operation_id": "128f274395254cf17eda6b3eb3d021b9",
  "status": "completed"
}

Create a file or folder

Create an empty document, spreadsheet, presentation or folder. Workiva makes it in the background, so it may take a few seconds to open.

Inputs

NamenametextRequired
The new file's name.
Kindfile_kindtextRequired
What to create.One of: Document, Spreadsheet, Presentation, Folder.
Folderfolder_idtext
The folder. Leave empty for the top level.

Outputs

fileobject
The new file
file_idtext
The new file's ID
Example output
{
  "file": {
    "container": "",
    "created": {
      "dateTime": "2026-07-01T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "id": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
    "kind": "Folder",
    "modified": {
      "dateTime": "2026-10-28T13:15:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "name": "2026 Close",
    "state": "Active",
    "template": false,
    "type": "Folder"
  },
  "file_id": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC"
}

Create a milestone

Mark the current version of a document, spreadsheet or presentation with a milestone, such as the version sent to the auditors.

Inputs

Filefile_idtextRequired
The document, spreadsheet or presentation. Pick one, or give a file ID from an earlier step.
TitletitletextRequired
The milestone's title, up to 200 characters.
Remarksremarkstext
A note about this version.

Outputs

milestoneobject
The milestone
milestone_idtext
The milestone's ID
operation_idtext
The Workiva operation that did the work, for 'Get an operation'
Example output
{
  "milestone": {
    "created": {
      "dateTime": "2026-10-28T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "id": "bWlsZXN0b25lLXYxOjQzODU0ZmU0NmU2MDQ4M2E4MTU0ZjdmMGI3MWI5YjllOjJjNjQzOGFi",
    "remarks": "Version shared with the audit team",
    "resource": {
      "type": "document"
    },
    "title": "Sent to auditors"
  },
  "milestone_id": "bWlsZXN0b25lLXYxOjQzODU0ZmU0NmU2MDQ4M2E4MTU0ZjdmMGI3MWI5YjllOjJjNjQzOGFi",
  "operation_id": "128f274395254cf17eda6b3eb3d021b9"
}

Create a task

Create a task, optionally on a file, with assignees, a due date and an approval step.

Inputs

TitletitletextRequired
What the task is.
Descriptiondescriptiontext
More about what to do.
Duedue_datedate and time
When the task is due.
Assigneesassignee_idslist
Who does the task. Needs the organization ID on the connection.
Approversapprover_idslist
Who approves the task. Leave empty for no approval step.
Approval byapproval_modetext
Whether one approver is enough or every approver must approve.One of: ONE (Any one approver), ALL (Every approver). Default: ONE.
Filefile_idtext
The document, spreadsheet or presentation the task is about. It can't be changed later.
Notify peoplenotifytrue/false
Email the people on the task. Defaults to Workiva's own setting.

Outputs

taskobject
The task
task_idtext
The task's ID
Example output
{
  "task": {
    "approvalSteps": [
      {
        "completionMode": "ONE",
        "dueDate": null,
        "participants": [
          {
            "id": "V0ZVc2VyHzY0MTI5NzM0MzkxODg5OTI",
            "type": "USER"
          }
        ],
        "responses": []
      }
    ],
    "assignees": [
      {
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "type": "USER"
      }
    ],
    "created": {
      "dateTime": "2026-10-28T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "description": "Tie the cash balance to the bank statement",
    "dueAt": "2026-11-15T00:00:00Z",
    "dueDate": "2026-11-15T00:00:00Z",
    "id": "129g274495354cf18edb6b3ea3d023b2",
    "location": {
      "resource": "8bd6ec9d30684550b6f6ac30e764cd22",
      "segment": null
    },
    "modified": {
      "dateTime": "2026-10-29T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "owner": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
    "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQ",
    "status": "Awaiting Approval",
    "title": "Review cash tie-out"
  },
  "task_id": "129g274495354cf18edb6b3ea3d023b2"
}

Delete a sheet

Delete a sheet from a spreadsheet.

Inputs

Spreadsheetspreadsheet_idtextRequired
The spreadsheet. Pick one, or give its file ID from an earlier step.
Sheetsheet_idtextRequired
The sheet in that spreadsheet. Pick one, or give a sheet ID.

Outputs

deletedtrue/false
Whether it was deleted
sheet_idtext
The sheet's ID
Example output
{
  "deleted": true,
  "sheet_id": "242a56d3cc0742c8abad0820bd318b23"
}

Delete a task

Delete a task.

Inputs

Task IDtask_idtextRequired
The task's ID, from 'List tasks', 'Create a task' or a task trigger.

Outputs

deletedtrue/false
Whether it was deleted
task_idtext
The task's ID
Example output
{
  "deleted": true,
  "task_id": "129g274495354cf18edb6b3ea3d023b2"
}

Export a file

Export a document (PDF, Word or XHTML), spreadsheet (PDF, Excel or CSV) or presentation (PDF or PowerPoint) and save the file, ready to attach or upload in a later step.

Inputs

Filefile_idtextRequired
The document, spreadsheet or presentation. Pick one, or give a file ID from an earlier step.
Formatexport_formattextRequired
The format to export as. It must suit the file's kind.One of: pdf (PDF (documents, spreadsheets and presentations)), docx (Word .docx (documents)), xhtml (XHTML (documents)), xlsx (Excel .xlsx (spreadsheets)), csv (CSV (spreadsheets)), pptx (PowerPoint .pptx (presentations)).

Outputs

content_typetext
The saved file's type
document_reftext
The saved file, for steps that take a file
export_formattext
The format it was exported as
file_idtext
The Workiva file that was exported
file_nametext
Its name in Workiva
filenametext
The saved file's name
operation_idtext
The Workiva operation that did the work, for 'Get an operation'
size_bytesnumber
Its size in bytes
urltext
A link to the saved file in this workspace
Example output
{
  "content_type": "application/pdf",
  "document_ref": "doc_7f3a9c2e5b1d4f60",
  "export_format": "pdf",
  "file_id": "124efa2a142f472ba1ceab34ed18915f",
  "file_name": "2026 Q3 10-Q",
  "filename": "2026 Q3 10-Q.pdf",
  "operation_id": "128f274395254cf17eda6b3eb3d021b9",
  "size_bytes": 482113,
  "url": "/actions/core/serve-document/doc_7f3a9c2e5b1d4f60"
}

Get a file

Get one file or folder: its name, kind, folder and when it last changed.

Inputs

Filefile_idtextRequired
The file or folder. Pick one, or give a file ID from an earlier step.

Outputs

fileobject
The file
Example output
{
  "file": {
    "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
    "created": {
      "dateTime": "2026-07-01T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "id": "124efa2a142f472ba1ceab34ed18915f",
    "kind": "Document",
    "modified": {
      "dateTime": "2026-10-28T13:15:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "name": "2026 Q3 10-Q",
    "state": "Active",
    "template": false,
    "type": "10-Q"
  }
}

Get a task

Get one task with its status, assignees and approval steps.

Inputs

Task IDtask_idtextRequired
The task's ID, from 'List tasks', 'Create a task' or a task trigger.

Outputs

taskobject
The task
task_idtext
The task's ID
Example output
{
  "task": {
    "approvalSteps": [
      {
        "completionMode": "ONE",
        "dueDate": null,
        "participants": [
          {
            "id": "V0ZVc2VyHzY0MTI5NzM0MzkxODg5OTI",
            "type": "USER"
          }
        ],
        "responses": []
      }
    ],
    "assignees": [
      {
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "type": "USER"
      }
    ],
    "created": {
      "dateTime": "2026-10-28T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "description": "Tie the cash balance to the bank statement",
    "dueAt": "2026-11-15T00:00:00Z",
    "dueDate": "2026-11-15T00:00:00Z",
    "id": "129g274495354cf18edb6b3ea3d023b2",
    "location": {
      "resource": "8bd6ec9d30684550b6f6ac30e764cd22",
      "segment": null
    },
    "modified": {
      "dateTime": "2026-10-29T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "owner": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
    "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQ",
    "status": "Awaiting Approval",
    "title": "Review cash tie-out"
  },
  "task_id": "129g274495354cf18edb6b3ea3d023b2"
}

Get an operation

Check on a long-running Workiva operation, such as a copy, export or import that was still running when its step stopped waiting.

Inputs

Operation IDoperation_idtextRequired
The operation's ID (or its address), from an earlier Workiva step or error.

Outputs

is_donetrue/false
Whether it completed
is_failedtrue/false
Whether it failed or was cancelled
operationobject
The operation
operation_idtext
The operation's ID
resource_urltext
Where its result is, once completed
statustext
acknowledged, queued, started, completed, cancelled or failed
Example output
{
  "is_done": true,
  "is_failed": false,
  "operation": {
    "created": {
      "dateTime": "2026-10-28T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "details": [],
    "id": "128f274395254cf17eda6b3eb3d021b9",
    "originalRequest": "7bee78f7-417b-42bc-ace9-e588c65d19bf",
    "resourceUrl": "https://api.app.wdesk.com/operations/128f274395254cf17eda6b3eb3d021b9/copyFileResults",
    "status": "completed",
    "updated": {
      "dateTime": "2026-10-28T15:04:20Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    }
  },
  "operation_id": "128f274395254cf17eda6b3eb3d021b9",
  "resource_url": "https://api.app.wdesk.com/operations/128f274395254cf17eda6b3eb3d021b9/copyFileResults",
  "status": "completed"
}

Import a file

Upload a file to Workiva: an Excel or CSV file becomes a spreadsheet, a Word file a document, a PowerPoint or Visio file a presentation, or keep any file as a supporting document.

Inputs

FilefiletextRequired
The file: upload it, pick one from an earlier step, or give a link.
Import asfile_kindtextRequired
What it becomes in Workiva.One of: Spreadsheet (Spreadsheet (from .xlsx or .csv)), Document (Document (from .docx)), Presentation (Presentation (from .pptx or .vsdx)), SupportingDocument (Supporting document (any file, kept as it is)).
File namefile_nametext
The name to give it, with its extension. Leave empty to keep the file's own name.
Folderfolder_idtext
The folder. Leave empty for the top level.

Outputs

fileobject
The new file
file_idtext
The new file's ID
operation_idtext
The Workiva operation that did the work, for 'Get an operation'
Example output
{
  "file": {
    "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
    "created": {
      "dateTime": "2026-07-01T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "id": "8bd6ec9d30684550b6f6ac30e764cd22",
    "kind": "Spreadsheet",
    "modified": {
      "dateTime": "2026-10-28T13:15:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "name": "Q3 Account Reconciliations",
    "state": "Active",
    "template": false,
    "type": "Spreadsheet"
  },
  "file_id": "8bd6ec9d30684550b6f6ac30e764cd22",
  "operation_id": "128f274395254cf17eda6b3eb3d021b9"
}

List activities

List what was done in your Workiva organization, or one workspace, newest first: sign-ins, users added, roles and settings changed. Needs the organization ID on the connection and an admin user.

Inputs

Workspaceworkspace_idtext
Only activity in this workspace. Leave empty for the whole organization.
Activity typesactivity_typeslist
Only these kinds of activity. Leave empty for every kind.
Done byperformer_idtext
Only activity by this person.
Fromsincedate and time
The earliest time to include.
Tountildate and time
The latest time to include.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

activitieslist
The activities
countnumber
How many were returned
has_moretrue/false
Whether there are more than were returned
Example output
{
  "activities": [
    {
      "action": {
        "alias": "workspace_membership_create",
        "category": "Administration",
        "id": "com.workiva.administration.workspace_membership.create",
        "name": "Workspace membership created"
      },
      "activityDateTime": "2026-10-30T14:11:02Z",
      "id": "NjE0MjIxODItOTVkYi00YmFjLWI4ZjktNzRkMDg1OTdlMDgw",
      "organization": {
        "id": "a25bc16f-fb62-4aff-a87e-1cca4b2113c0",
        "name": "Example Inc."
      },
      "outcome": "success",
      "performer": {
        "displayName": "Adam Admin",
        "id": "V0ZWc2VyHzE0NT8xNzAyMDA",
        "ipAddress": "192.0.2.10",
        "type": "com.workiva.iam.principal.user",
        "uniqueName": "admin@example.com"
      },
      "summary": "Adam Admin added the user 'John Public' to the workspace 'SEC Reporting'",
      "targets": [
        {
          "displayName": "John Public",
          "id": "V0ZVc2VyHzY0ODY4NjQ1MzE1NTQ",
          "type": "com.workiva.administration.user",
          "uniqueName": "john_public"
        }
      ],
      "workspace": {
        "id": "QWNjb3VudB81MzIzMjkwOTM4NzAzODcy",
        "name": "SEC Reporting"
      }
    }
  ],
  "count": 1,
  "has_more": false
}

List files

List the files and folders the connection's Workiva user can open, most recently changed first, optionally of one kind or in one folder.

Inputs

Kindfile_kindtext
Only files of this kind. Leave empty for every kind.One of: Document (Documents), Spreadsheet (Spreadsheets), Presentation (Presentations), Folder (Folders), SupportingDocument (Supporting documents (PDFs and other files)), Script (Scripts).
Folderfolder_idtext
The folder. Leave empty for the top level.
Ordersorttext
The order to list them in.One of: modified.dateTime desc (Most recently changed first), modified.dateTime asc (Least recently changed first), name asc (Name, A to Z), name desc (Name, Z to A). Default: modified.dateTime desc.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many were returned
fileslist
The files
has_moretrue/false
Whether there are more than were returned
Example output
{
  "count": 2,
  "files": [
    {
      "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
      "created": {
        "dateTime": "2026-07-01T15:03:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "kind": "Document",
      "modified": {
        "dateTime": "2026-10-28T13:15:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "name": "2026 Q3 10-Q",
      "state": "Active",
      "template": false,
      "type": "10-Q"
    },
    {
      "container": "V0ZEYXRhRW50aXR5HkZvbGRlcjpyMTY0NEU1ZkY2OTA1QkM5QTSCMyZCRkRzQzNDO1FGNC",
      "created": {
        "dateTime": "2026-07-01T15:03:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "id": "8bd6ec9d30684550b6f6ac30e764cd22",
      "kind": "Spreadsheet",
      "modified": {
        "dateTime": "2026-10-28T13:15:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "name": "Q3 Account Reconciliations",
      "state": "Active",
      "template": false,
      "type": "Spreadsheet"
    }
  ],
  "has_more": false
}

List milestones

List the milestones of a document, spreadsheet or presentation.

Inputs

Filefile_idtextRequired
The document, spreadsheet or presentation. Pick one, or give a file ID from an earlier step.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many were returned
has_moretrue/false
Whether there are more than were returned
milestoneslist
The milestones
Example output
{
  "count": 1,
  "has_more": false,
  "milestones": [
    {
      "created": {
        "dateTime": "2026-10-28T15:03:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "id": "bWlsZXN0b25lLXYxOjQzODU0ZmU0NmU2MDQ4M2E4MTU0ZjdmMGI3MWI5YjllOjJjNjQzOGFi",
      "remarks": "Version shared with the audit team",
      "resource": {
        "type": "document"
      },
      "title": "Sent to auditors"
    }
  ]
}

List record types

List the kinds of Integrated Risk records your workspaces keep (such as controls, risks and issues) and the properties each has.

Inputs

None.

Outputs

countnumber
How many were returned
typeslist
The record types
Example output
{
  "count": 2,
  "types": [
    {
      "id": "Issue",
      "properties": [
        "title",
        "dateReported",
        "email"
      ]
    },
    {
      "id": "Control",
      "properties": [
        "controlId",
        "owner",
        "frequency"
      ]
    }
  ]
}

List records

List Integrated Risk records of one type, such as every control or issue, or get one by its ID.

Inputs

Record typerecord_typetextRequired
The kind of record. Pick one, or type its name.
Record IDrecord_idtext
Only this record.
Include relationshipsinclude_relationshipstrue/false
Also return how each record links to others.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many were returned
has_moretrue/false
Whether there are more than were returned
recordslist
The records
Example output
{
  "count": 1,
  "has_more": false,
  "records": [
    {
      "id": "931c768b-c3dd-4392-b56e-06d7d6ff88a6",
      "properties": {
        "dateReported": {
          "datatype": "date-time",
          "value": "2026-10-11T00:00:00Z"
        },
        "title": {
          "datatype": "string",
          "value": "Late bank reconciliation"
        }
      },
      "relationships": [],
      "type": "Issue"
    }
  ]
}

List sheets

List the sheets of a spreadsheet.

Inputs

Spreadsheetspreadsheet_idtextRequired
The spreadsheet. Pick one, or give its file ID from an earlier step.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many were returned
has_moretrue/false
Whether there are more than were returned
sheetslist
The sheets
Example output
{
  "count": 1,
  "has_more": false,
  "sheets": [
    {
      "id": "242a56d3cc0742c8abad0820bd318b23",
      "index": 0,
      "lock": null,
      "name": "Cash",
      "revision": "2B3C4D5E"
    }
  ]
}

List tasks

List tasks, most recently changed first, by assignee, file, title, due date or when they changed.

Inputs

Assigneeassignee_idtext
Only tasks assigned to this person. Needs the organization ID on the connection.
Filefile_idtext
Only tasks on this file.
Title containstitle_containstext
Only tasks whose title has these words.
Due afterdue_afterdate and time
Only tasks due on or after this time.
Due beforedue_beforedate and time
Only tasks due on or before this time.
Changed sincechanged_sincedate and time
Only tasks changed since this time.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many were returned
has_moretrue/false
Whether there are more than were returned
taskslist
The tasks
Example output
{
  "count": 1,
  "has_more": false,
  "tasks": [
    {
      "approvalSteps": [
        {
          "completionMode": "ONE",
          "dueDate": null,
          "participants": [
            {
              "id": "V0ZVc2VyHzY0MTI5NzM0MzkxODg5OTI",
              "type": "USER"
            }
          ],
          "responses": []
        }
      ],
      "assignees": [
        {
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "type": "USER"
        }
      ],
      "created": {
        "dateTime": "2026-10-28T15:03:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "description": "Tie the cash balance to the bank statement",
      "dueAt": "2026-11-15T00:00:00Z",
      "dueDate": "2026-11-15T00:00:00Z",
      "id": "129g274495354cf18edb6b3ea3d023b2",
      "location": {
        "resource": "8bd6ec9d30684550b6f6ac30e764cd22",
        "segment": null
      },
      "modified": {
        "dateTime": "2026-10-29T15:03:27Z",
        "user": {
          "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
        }
      },
      "owner": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
      "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQ",
      "status": "Awaiting Approval",
      "title": "Review cash tie-out"
    }
  ]
}

List users

List the people in your Workiva organization, with the IDs tasks and filters use. Needs the organization ID on the connection.

Inputs

Searchsearchtext
Only people whose name, or email address, contains this.
Most to returnlimitnumber
The most to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many were returned
has_moretrue/false
Whether there are more than were returned
userslist
The users
Example output
{
  "count": 1,
  "has_more": false,
  "users": [
    {
      "displayName": "Jane Smith",
      "email": "jane.smith@example.com",
      "familyName": "Smith",
      "givenName": "Jane",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
      "status": "active",
      "username": "jane.smith@example.com"
    }
  ]
}

Move a file to the trash

Move a file or folder to the trash (a folder with everything in it). It can be restored from the trash in Workiva.

Inputs

Filefile_idtextRequired
The file or folder. Pick one, or give a file ID from an earlier step.

Outputs

file_idtext
The file's ID
operation_idtext
The Workiva operation that did the work, for 'Get an operation'
statustext
The operation's final status
trashedtrue/false
Whether it is in the trash
Example output
{
  "file_id": "124efa2a142f472ba1ceab34ed18915f",
  "operation_id": "128f274395254cf17eda6b3eb3d021b9",
  "status": "completed",
  "trashed": true
}

Read cells

Read the values in a range of a sheet, row by row.

Inputs

Spreadsheetspreadsheet_idtextRequired
The spreadsheet. Pick one, or give its file ID from an earlier step.
Sheetsheet_idtextRequired
The sheet in that spreadsheet. Pick one, or give a sheet ID.
Cellscell_rangetextRequired
The cells, in A1 style: a range such as A1:C10, or whole columns such as A:C.
Valuesvalue_styletext
What to read from cells with formulas.One of: calculated (Calculated values (what the cells show)), raw (Raw values (formulas as written)). Default: calculated.

Outputs

rangetext
The range read
row_countnumber
How many rows were read
valueslist
The rows, each a list of cell values
Example output
{
  "range": "A1:B3",
  "row_count": 3,
  "values": [
    [
      "Account",
      "Balance"
    ],
    [
      "Cash",
      125000
    ],
    [
      "Receivables",
      48250.5
    ]
  ]
}

Update a task

Change a task's title, description, due date or assignees. Changing the assignees restarts the task.

Inputs

Task IDtask_idtextRequired
The task's ID, from 'List tasks', 'Create a task' or a task trigger.
Titletitletext
What the task is.
Descriptiondescriptiontext
More about what to do.
Duedue_datedate and time
When the task is due.
Assigneesassignee_idslist
Who does the task. Needs the organization ID on the connection.

Outputs

taskobject
The task
task_idtext
The task's ID
Example output
{
  "task": {
    "approvalSteps": [
      {
        "completionMode": "ONE",
        "dueDate": null,
        "participants": [
          {
            "id": "V0ZVc2VyHzY0MTI5NzM0MzkxODg5OTI",
            "type": "USER"
          }
        ],
        "responses": []
      }
    ],
    "assignees": [
      {
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "type": "USER"
      }
    ],
    "created": {
      "dateTime": "2026-10-28T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "description": "Tie the cash balance to the bank statement",
    "dueAt": "2026-11-15T00:00:00Z",
    "dueDate": "2026-11-15T00:00:00Z",
    "id": "129g274495354cf18edb6b3ea3d023b2",
    "location": {
      "resource": "8bd6ec9d30684550b6f6ac30e764cd22",
      "segment": null
    },
    "modified": {
      "dateTime": "2026-10-29T15:03:27Z",
      "user": {
        "id": "V0ZVc2VyHzU1MDg3OTc0MDE4MDg4OTY"
      }
    },
    "owner": "V3ZVc2VyFzV3NiQ5NDA2NjIzNxk2njH",
    "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQ",
    "status": "Awaiting Approval",
    "title": "Review cash tie-out"
  },
  "task_id": "129g274495354cf18edb6b3ea3d023b2"
}

Write cells

Write values into a range of a sheet, replacing what is there, and wait for Workiva to finish. Cells in the range that the rows don't reach are cleared.

Inputs

Spreadsheetspreadsheet_idtextRequired
The spreadsheet. Pick one, or give its file ID from an earlier step.
Sheetsheet_idtextRequired
The sheet in that spreadsheet. Pick one, or give a sheet ID.
Cellscell_rangetextRequired
The cells, in A1 style: a range such as A1:C10, or whole columns such as A:C.
RowsvalueslistRequired
The rows to write, each a list of cells: [["Revenue", 1200], ["Costs", 800]]. Every row has the same number of cells; null leaves a cell as it is.

Outputs

operation_idtext
The Workiva operation that did the work, for 'Get an operation'
rangetext
The range written
row_countnumber
How many rows were written
statustext
The operation's final status
Example output
{
  "operation_id": "128f274395254cf17eda6b3eb3d021b9",
  "range": "A1:B2",
  "row_count": 2,
  "status": "completed"
}

On this page