Manage Applications

    Get file tasks

    get
    https://api.box.com/2.0
    /files/:file_id/tasks

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

    Request

    application/json

    Path Parameters

    stringin pathrequired
    12345

    The unique identifier that represent 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

    application/jsonTasks

    Returns a collection of task objects. If there are no tasks on this file an empty collection will be returned.

    application/jsonClient Error

    Returns an error if the file for the given ID does not exist or is inaccessible to your account.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/files/12345/tasks \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxCollection<BoxTask> tasks = await client.FilesManager.FilesManager.GetFileTasks("11111");
    Java
    BoxFile file = new BoxFile(api, "id");
    List<BoxTask.Info> tasks = file.getTasks();
    Python
    tasks = client.file(file_id='11111').get_tasks()
    for task in tasks:
        print('Task ID is {0} and the type is {1}'.format(task.id, task.type))
    Node
    client.files.getTasks('11111')
    	.then(tasks => {
    		/* tasks -> {
    			total_count: 1,
    			entries: 
    			[ { type: 'task',
    				id: '22222',
    				item: 
    					{ type: 'file',
    					id: '11111',
    					sequence_id: '6',
    					etag: '6',
    					sha1: '81cc829fb8366fcfc108aa6c5a9bde01a6a10c16',
    					name: 'box-logo.png' },
    				due_at: null } ] }
    		*/
    	});

    Response Example

    {
      "total_count": 5000,
      "entries": [
        {
          "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"
        }
      ]
    }