Manage Applications

    Get task

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

    Fetches a specific task.

    Request

    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 if the task for the given ID does not exist or is inaccessible to your account.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/tasks/12345 \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxTask task = await client.TasksManager.GetTaskAsync("11111");
    Java
    BoxTask task = new BoxTask(api, "id");
    BoxTask.Info info = task.getInfo();
    Python
    task = client.task(task_id='12345').get()
    print('Task ID is {0} and the type is {1}'.format(task.id, task.type))
    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",
      "item": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf"
      },
      "due_at": "2012-12-12T10:53:43-08:00",
      "action": "review",
      "message": "Legal review",
      "task_assignment_collection": {
        "total_count": 5000,
        "limit": 1000,
        "offset": 2000,
        "order": [
          {
            "by": "type",
            "direction": "ASC"
          }
        ],
        "entries": [
          {
            "id": 11446498,
            "type": "task_assignment",
            "item": {
              "id": 12345,
              "etag": 1,
              "type": "file",
              "sequence_id": 3,
              "name": "Contract.pdf"
            },
            "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"
    }