Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!List task assignments
Lists all of the assignments for a given task.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
12345The ID of the task.
Response
application/jsonTask assignments
Returns a collection of task assignment defining what task on a file has been assigned to which users and by who.
application/jsonClient error
Returns an error when the task could not be found or the user does not have access to the file the task is assigned to.
application/jsonClient error
Returns an error if the task assignment ID was omitted in the request.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/tasks/12345/assignments" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.taskAssignments.getTaskAssignments(task.id!);Python Gen
client.task_assignments.get_task_assignments(task.id).NET Gen
await client.TaskAssignments.GetTaskAssignmentsAsync(taskId: NullableUtils.Unwrap(task.Id));Swift Gen (Beta)
try await client.taskAssignments.getTaskAssignments(taskId: task.id!)Java
BoxTask task = new BoxTask(api, "id");
task.getAssignments();.NET
BoxCollection<BoxTaskAssignment> assignments = await client.TasksManager
.GetAssignmentsAsync(taskId: "11111");Node
client.tasks.getAssignments('11111')
.then(assignments => {
/* assignments -> {
total_count: 1,
entries:
[ { type: 'task_assignment',
id: '22222',
item:
{ type: 'file',
id: '44444',
sequence_id: '0',
etag: '0',
sha1: '0bbd79a105c504f99573e3799756debba4c760cd',
name: 'box-logo.png' },
assigned_to:
{ type: 'user',
id: '33333',
name: 'Example User',
login: 'user@example.com' } } ] }
*/
});Response Example
{
"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"
}
}
],
"total_count": 100
}