Manage Applications

    Task

    Tasks allow for file-centric workflows in Box. Users can create tasks on files and assign them to collaborators on Box.

    string
    review

    Value is always "review"

    all_assignees

    When a task is created with completion rule "all_assignees" (default), the task will only be considered completed when all assignees have completed the task. When a task is created with completion rule "any_assignee", the task will be considered completed when one assignee has completed the task.

    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

    {
      "id": 11446498,
      "type": "task",
      "item": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf"
      },
      "due_at": "2012-12-12T10:53:43-08:00",
      "action": "review",
      "message": "Legal review",
      "task_assignment_collection": {
        "total_count": 5000,
        "limit": 1000,
        "offset": 2000,
        "order": [
          {
            "by": "type",
            "direction": "ASC"
          }
        ],
        "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"
            }
          }
        ]
      },
      "is_completed": true,
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "created_at": "2012-12-12T10:53:43-08:00",
      "completion_rule": "all_assignees"
    }