v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Tasks

List tasks on file

Retrieves a list of all the tasks for a file. This endpoint does not support pagination.

get/files/{file_id}/tasks

Path parameters

file_idstring required

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Response

Returns a list of tasks on a file.

If there are no tasks on this file an empty collection is returned instead.

total_countinteger

One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than total_count.

Example response

{
  "total_count": 5000,
  "entries": [
    {
      "id": "11446498",
      "type": "task",
      "item": {
        "id": "12345",
        "etag": "1",
        "type": "file",
        "sequence_id": "3",
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        }
      },
      "due_at": "2012-12-12T10:53:43-08:00",
      "action": "review",
      "message": "Legal review",
      "task_assignment_collection": {
        "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"
            }
          }
        ]
      },
      "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"
    }
  ]
}