List tasks on file
Retrieves a list of all the tasks for a file. This endpoint does not support pagination.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
12345The 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
application/jsonTasks
Returns a list of tasks on a file.
If there are no tasks on this file an empty collection is returned instead.
application/jsonClient error
Returns an error when the file could not be found or the user does not have access to the file.
application/jsonClient error
Returns an error when the file_id was not provided.
application/jsonClient error
Returns an error when an attempt was made to retrieve tasks for the file
with ID 0.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/tasks" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.tasks.getFileTasks(file.id);Python Gen
client.tasks.get_file_tasks(file.id).NET Gen
await client.Tasks.GetFileTasksAsync(fileId: file.Id);Swift Gen (Beta)
try await client.tasks.getFileTasks(fileId: file.id)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(f'Task ID is {task.id} and the type is {task.type}').NET
BoxCollection<BoxTask> tasks = await client.FilesManager.FilesManager.GetFileTasks("11111");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 } ] }
*/
});iOS
let iterator = client.files.listTasks(forFile: "11111")
iterator.next { results in
switch results {
case let .success(page):
for task in page.entries {
print("Task messsage: \(task.message)")
}
case let .failure(error):
print(error)
}
}Response Example
{
"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"
}
],
"total_count": 5000
}