Box Developer Documentation
Log in

Task assignment

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

A task assignment defines which task is assigned to which user to complete.

string
11446498

The unique identifier for this task assignment.

string
task_assignment

The value will always be task_assignment.

Value is always task_assignment

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

The date at which this task was assigned to the user.

User (Mini) object

The user who assigned this task.

User (Mini) object

The user that the task has been assigned to.

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

The date at which this task assignment was completed. This will be null if the task is not completed yet.

File (Mini) object

The file that the task has been assigned to.

string
Please review

A message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.

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

The date at which the assigned user was reminded of this task assignment.

string
incomplete

The current state of the assignment. The available states depend on the action value of the task object.

Value is one of completed,incomplete,approved,rejected

Response Example

{
  "id": "11446498",
  "type": "task_assignment",
  "assigned_at": "2012-12-12T10:53:43-08:00",
  "assigned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "assigned_to": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "completed_at": "2012-12-12T10:53:43-08:00",
  "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": "Please review",
  "reminded_at": "2012-12-12T10:53:43-08:00",
  "resolution_state": "incomplete"
}