Skip to main content
API version 2024.0 A task allows for file-centric workflows within Box. Users can create tasks on files and assign them to other users for them to complete the tasks.
​
id
string
example: 11446498The unique identifier for this task.
​
type
string
example: taskThe value will always be task.Value is always task
​
action
string
example: reviewThe type of task the task assignee will be prompted to perform.Value is one of review,complete
​
completion_rule
string
example: all_assigneesDefines which assignees need to complete this task before the task is considered completed.
  • all_assignees requires all assignees to review or approve the task in order for it to be considered completed.
  • any_assignee accepts any one assignee to review or approve the task in order for it to be considered completed.
Value is one of all_assignees,any_assignee
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the task object was created.
​
created_by
User (Mini)object
The user who created the task.
​
due_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When the task is due.
​
is_completed
boolean
example: trueWhether the task has been completed.
​
item
File (Mini)object
The file associated with the task.
​
message
string
example: Legal reviewA message that will be included with the task.
​
task_assignment_collection
Task assignmentsobject
A collection of task assignment objects associated with the task.
{
  "id": "11446498",
  "type": "task",
  "action": "review",
  "completion_rule": "all_assignees",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "due_at": "2012-12-12T10:53:43-08:00",
  "is_completed": true,
  "item": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "name": "Contract.pdf",
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
  },
  "message": "Legal review",
  "task_assignment_collection": {
    "entries": [
      {
        "assigned_at": "2012-12-12T10:53:43-08:00",
        "assigned_by": {
          "id": "11446498",
          "type": "user",
          "login": "[email protected]",
          "name": "Aaron Levie"
        },
        "assigned_to": {
          "id": "11446498",
          "type": "user",
          "login": "[email protected]",
          "name": "Aaron Levie"
        },
        "completed_at": "2012-12-12T10:53:43-08:00",
        "id": "11446498",
        "item": {
          "etag": "1",
          "id": "12345",
          "type": "file",
          "file_version": {
            "id": "12345",
            "type": "file_version",
            "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
          },
          "name": "Contract.pdf",
          "sequence_id": "3",
          "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
        },
        "message": "Please review",
        "reminded_at": "2012-12-12T10:53:43-08:00",
        "resolution_state": "incomplete",
        "type": "task_assignment"
      }
    ],
    "total_count": 100
  }
}