Box Developer Documentation
Log in
Latest version

Get task assignment

get
https://api.box.com/2.0
/task_assignments/:task_assignment_id

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

Retrieves information about a task assignment.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the task assignment.

Response

application/jsonTask assignment

Returns a task assignment, specifying who the task has been assigned to and by whom.

application/jsonClient error

Returns an error when the task assignment could not be found or the user does not have access to the file the task is assigned to.

application/jsonClient error

An unexpected client error.

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

Request Example

Learn more about Box SDK versionig strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/task_assignments/12345" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.taskAssignments.getTaskAssignmentById(taskAssignment.id!);
Python v10
client.task_assignments.get_task_assignment_by_id(task_assignment.id)
.NET v10
await client.TaskAssignments.GetTaskAssignmentByIdAsync(taskAssignmentId: NullableUtils.Unwrap(taskAssignment.Id));
Swift v10
try await client.taskAssignments.getTaskAssignmentById(taskAssignmentId: taskAssignment.id!)
Java v10
client.getTaskAssignments().getTaskAssignmentById(taskAssignment.getId())
Java v4
String assignmentID = "4256974";
BoxTaskAssignment.Info assignmentInfo = new BoxTaskAssignment(api, assignmentID).getInfo();
Python v3
assignment= client.task_assignment('12345').get()
print(f'Assignment ID is {assignment.id} and assignment type is {assignment.type}')
.NET v5
BoxTaskAssignment assignment = await client.TasksManager.GetTaskAssignmentAsync("12345");
Node v3
client.tasks.getAssignment('12345')
	.then(assignment => {
		/* assignment -> {
			type: 'task_assignment',
			id: '12345',
			item: 
			{ type: 'file',
				id: '33333',
				sequence_id: '0',
				etag: '0',
				sha1: '7840095ee096ee8297676a138d4e316eabb3ec96',
				name: 'script.js' },
			assigned_to: 
			{ type: 'user',
				id: '22222',
				name: 'Sample Assignee',
				login: 'assignee@exmaple.com' },
			message: null,
			completed_at: null,
			assigned_at: '2013-05-10T11:43:41-07:00',
			reminded_at: null,
			resolution_state: 'incomplete',
			assigned_by: 
			{ type: 'user',
				id: '33333',
				name: 'Example User',
				login: 'user@example.com' } }
		*/
	});

Response Example

{
  "id": "11446498",
  "type": "task_assignment",
  "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",
  "item": {
    "id": "12345",
    "type": "file",
    "etag": "1",
    "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"
}