Box Developer Documentation
Log in
Latest version

Get task

get
https://api.box.com/2.0
/tasks/:task_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 specific task.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The ID of the task.

Response

application/jsonTask

Returns a task object.

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

An unexpected client error.

get
Get task
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" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.tasks.getTaskById(task.id!);
Python Gen
client.tasks.get_task_by_id(task.id)
.NET Gen
await client.Tasks.GetTaskByIdAsync(taskId: NullableUtils.Unwrap(task.Id));
Swift Gen (Beta)
try await client.tasks.getTaskById(taskId: task.id!)
Java Gen (Beta)
client.getTasks().getTaskById(task.getId())
Java
BoxTask task = new BoxTask(api, "id");
BoxTask.Info info = task.getInfo();
Python
task = client.task(task_id='12345').get()
print(f'Task ID is {task.id} and the type is {task.type}')
.NET
BoxTask task = await client.TasksManager.GetTaskAsync("11111");
Node
client.tasks.get('11111')
	.then(task => {
		/* task -> {
			type: 'task',
			id: '11111',
			item: 
			{ type: 'file',
				id: '22222',
				sequence_id: '0',
				etag: '0',
				sha1: '0bbd79a105c504f99573e3799756debba4c760cd',
				name: 'box-logo.png' },
			due_at: '2014-04-03T11:09:43-07:00',
			action: 'review',
			message: 'Please review for publication!',
			task_assignment_collection: { total_count: 0, entries: [] },
			is_completed: false,
			created_by: 
			{ type: 'user',
				id: '33333',
				name: 'Example User',
				login: 'user@example.com' },
			created_at: '2013-04-03T11:12:54-07:00' }
		*/
	});

Response Example

{
  "id": "11446498",
  "type": "task",
  "action": "review",
  "completion_rule": "all_assignees",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "due_at": "2012-12-12T10:53:43-08:00",
  "is_completed": true,
  "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": "Legal review",
  "task_assignment_collection": {
    "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
  }
}