Tasks

Tasks enable users to manage projects, organize responsibilities, and meet deadlines in the Workiva platform. Use these endpoints to create and manage tasks.

Task

Properties

Name	Type	Description	Restrictions
assignee	User	The user's ID, display name, and email address
completed	Action	When the action was performed, and details about the user who did it	read-only
created	Action	When the action was performed, and details about the user who did it	read-only
description	string	The description of the task, up to 2000 characters
dueDate	string(date-time)	The task's due date
id	string	The unique identifier of the task	read-only
location	TaskLocation¦null	Details about what the task is attached to, such as a file ID. If null, the task isn't attached to anything. Once a location is attached to a task, that location cannot be changed.
modified	Action	When the action was performed, and details about the user who did it	read-only
sourceUrl	string	The link to the task in Wdesk Home or within a document.	read-only
status	string	Whether the task is `Created`, `Completed`, or `Cancelled`
title	string	The title of the task, up to 500 characters

Enumerated Values

Property	Value
status	`Cancelled`
status	`Completed`
status	`Created`

Example

{
  "assignee": {
    "displayName": "string",
    "email": "string",
    "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
  },
  "completed": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "description": "Review document for spelling and grammar",
  "dueDate": "2019-10-30T00:00:00Z",
  "id": "128f274395254cf17eda6b3eb3d021b9",
  "location": {
    "file": "124efa2a142f472ba1ceab34ed18915f",
    "fileSegment": "465ttdh2a142y75ehsft5ab34edf5675"
  },
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "displayName": "string",
      "email": "string",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "sourceUrl": "https://app.wdesk.com/tasks/d/UVdOauIzVaVkQjdxTmzNNUOEUTQOakEnTnpJTE9ENXkuEkdGeaF4OENNJEV3NUTBmA?token=NTc0NDU2MTg1MjM0ODUyTM",
  "status": "Completed",
  "title": "Review Document"
}

TaskLocation

Properties

Name	Type	Description	Restrictions
file	string	The unique identifier of the file
fileSegment	string	The unique identifier of the fileSegment. A fileSegment is a section in a document, a sheet in a spreadsheet, or a slide in a presentation.

Example

{
  "file": "124efa2a142f472ba1ceab34ed18915f",
  "fileSegment": "465ttdh2a142y75ehsft5ab34edf5675"
}