Skip to main content

Task assignment

A task assignment defines which task is assigned to which user to complete.
PropertyTypeRequiredDescription
idstringNoThe unique identifier for this task assignment.
typeenum<string>NoThe value will always be task_assignment. Available options: task_assignment.
itemFile (Mini)NoThe file that the task has been assigned to.
assigned_toUser (Mini)NoThe user that the task has been assigned to.
messagestringNoA message that will is included with the task assignment. This is visible to the assigned user in the web and mobile UI.
completed_atstringNoThe date at which this task assignment was completed. This will be null if the task is not completed yet.
assigned_atstringNoThe date at which this task was assigned to the user.
reminded_atstringNoThe date at which the assigned user was reminded of this task assignment.
resolution_stateenum<string>NoThe current state of the assignment. The available states depend on the action value of the task object. Available options: completed, incomplete, approved, rejected.
assigned_byUser (Mini)NoThe user who assigned this task.
Example
{
  "id": "11446498",
  "type": "task_assignment",
  "item": {
    "id": "12345",
    "etag": "1",
    "type": "file",
    "sequence_id": "3",
    "name": "Contract.pdf",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    }
  },
  "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"
  }
}

Task assignments

A list of task assignments.
PropertyTypeRequiredDescription
total_countintegerNoThe total number of items in this collection.
entriesarray of Task assignmentNoA list of task assignments.
Example
{
  "total_count": 100,
  "entries": [
    {
      "id": "11446498",
      "type": "task_assignment",
      "item": {
        "id": "12345",
        "etag": "1",
        "type": "file",
        "sequence_id": "3",
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        }
      },
      "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"
      }
    }
  ]
}
Last modified on July 9, 2026