Box Developer Documentation
Log in
Latest version

List task assignments

get
https://api.box.com/2.0
/tasks/:task_id/assignments

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Lists all of the assignments for a given task.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The 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.

get
List task assignments
You can now try out some of our APIs live, right here in the documentation.
Log in

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": [
    {
      "assigned_at": "2012-12-12T10:53:43-08:00",
      "assigned_by": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "assigned_to": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "completed_at": "2012-12-12T10:53:43-08:00",
      "id": "11446498",
      "item": {
        "etag": "1",
        "id": "12345",
        "type": "file",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "name": "Contract.pdf",
        "sequence_id": "3",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
      },
      "message": "Please review",
      "reminded_at": "2012-12-12T10:53:43-08:00",
      "resolution_state": "incomplete",
      "type": "task_assignment"
    }
  ],
  "total_count": 100
}