Task

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.

string
review

The type of task the task assignee will be prompted to perform.

Value is one of review,complete

all_assignees

Defines which assignees need to complete this task before the task is considered completed.

  • all_assignees requires all assignees to review or approve the the task in order for it to be considered completed.
  • any_assignee accepts any one assignee to review or approve the the task in order for it to be considered completed.

Value is one of all_assignees,any_assignee

string / date-time
2012-12-12T10:53:43-08:00

When the task object was created

The user who created the task

string / date-time
2012-12-12T10:53:43-08:00

When the task is due

string
11446498

The unique identifier for this object

boolean
true

Whether the task has been completed

The file associated with the task

string
Legal review

A message that will be included with the task

A collection of task assignment objects associated with the task

string
task

Value is always task

Response Example

{
  "action": "review",
  "completion_rule": "all_assignees",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "due_at": "2012-12-12T10:53:43-08:00",
  "id": 11446498,
  "is_completed": true,
  "item": {
    "etag": 1,
    "id": 12345,
    "name": "Contract.pdf",
    "sequence_id": 3,
    "type": "file"
  },
  "message": "Legal review",
  "task_assignment_collection": {
    "entries": [
      {
        "id": 11446498,
        "type": "task_assignment",
        "item": {
          "id": 12345,
          "etag": 1,
          "type": "file",
          "sequence_id": 3,
          "name": "Contract.pdf"
        },
        "assigned_to": {
          "id": 11446498,
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "message": "Please review",
        "completed_at": "2012-12-12T10:53:43-08:00",
        "assigned_at": "2012-12-12T10:53:43-08:00",
        "reminded_at": "2012-12-12T10:53:43-08:00",
        "resolution_state": "incomplete",
        "assigned_by": {
          "id": 11446498,
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        }
      }
    ],
    "total_count": 100
  },
  "type": "task"
}