Manage Applications

    Get trashed folder

    get
    https://api.box.com/2.0
    /folders/:folder_id/trash

    Retrieves a folder that has been moved to the trash.

    Request

    application/json

    Path Parameters

    stringin pathrequired
    0

    The unique identifier that represent a folder.

    The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the url https://*.app.box.com/folder/123 the folder_id is 123.

    The root folder of a Box account is always represented by the ID 0.

    Query Parameters

    string arrayin queryoptional
    id,type,name

    A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

    Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

    Response

    application/jsonFolder

    Returns the folder that was trashed, including information about when the it was moved to the trash.

    application/jsonClient Error

    Returns an error if the folder is not in the trash.

    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/folders/4353455/trash \
         -H "Authorization: Bearer <ACCESS_TOKEN>"
    .NET
    BoxFolder trashedFolder = await client.FoldersManager.GetTrashedFolderAsync("22222");
    Python
    folder = client.folder(folder_id='22222')
    folder_from_trash = client.trash().get_item(folder)
    print('Folder ID is {0} and name is {1}'.format(folder_from_trash.id, folder_from_trash.name))
    Node
    client.folders.getTrashedFolder('22222')
    	.then(trashedFolder => {
    		/* trashedFolder -> {
    			type: 'folder',
    			id: '22222',
    			sequence_id: '1',
    			etag: '1',
    			name: 'Old Files',
    			created_at: '2013-05-06T22:37:30-07:00',
    			modified_at: '2013-05-06T22:39:08-07:00',
    			description: '',
    			size: 18482,
    			path_collection: 
    			{ total_count: 1,
    				entries: 
    				[ { type: 'folder',
    					id: '1',
    					sequence_id: null,
    					etag: null,
    					name: 'Trash' } ] },
    			created_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			modified_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			trashed_at: '2013-05-29T09:37:13-07:00',
    			purged_at: null,
    			content_created_at: '2013-05-06T22:37:30-07:00',
    			content_modified_at: '2013-05-06T22:39:08-07:00',
    			owned_by: 
    			{ type: 'user',
    				id: '33333',
    				name: 'Example User',
    				login: 'user@example.com' },
    			shared_link: null,
    			folder_upload_email: null,
    			parent: 
    			{ type: 'folder',
    				id: '0',
    				sequence_id: null,
    				etag: null,
    				name: 'All Files' },
    			item_status: 'trashed' }
    		*/
    	});

    Response Example

    {
      "id": 12345,
      "etag": 1,
      "type": "folder",
      "sequence_id": 3,
      "name": "Contracts",
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "description": "Legal contracts for the new ACME deal",
      "size": 629644,
      "path_collection": {
        "total_count": 1,
        "entries": [
          {
            "id": 12345,
            "etag": 1,
            "type": "folder",
            "sequence_id": 3,
            "name": "Contracts"
          }
        ]
      },
      "created_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "modified_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "purged_at": "2012-12-12T10:53:43-08:00",
      "content_created_at": "2012-12-12T10:53:43-08:00",
      "content_modified_at": "2012-12-12T10:53:43-08:00",
      "expires_at": "2012-12-12T10:53:43-08:00",
      "owned_by": {
        "id": 11446498,
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "shared_link": {
        "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
        "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
        "vanity_url": "https://acme.app.box.com/v/my_url/",
        "access": "open",
        "effective_access": "company",
        "effective_permission": "can_download",
        "unshared_at": "2018-04-13T13:53:23-07:00",
        "is_password_enabled": true,
        "permissions": {
          "can_download": true,
          "can_preview": true
        },
        "download_count": 3,
        "preview_count": 3
      },
      "folder_upload_email": {
        "access": "open",
        "email": "upload.Contracts.asd7asd@u.box.com"
      },
      "parent": {
        "id": 12345,
        "etag": 1,
        "type": "folder",
        "sequence_id": 3,
        "name": "Contracts"
      },
      "item_status": "active",
      "item_collection": {
        "total_count": 5000,
        "limit": 1000,
        "offset": 2000,
        "order": [
          {
            "by": "type",
            "direction": "ASC"
          }
        ],
        "entries": [
          {
            "id": 12345,
            "etag": 1,
            "type": "file",
            "sequence_id": 3,
            "name": "Contract.pdf"
          }
        ]
      },
      "sync_state": "synced",
      "has_collaborations": true,
      "permissions": {
        "can_delete": true,
        "can_download": true,
        "can_invite_collaborator": true,
        "can_rename": true,
        "can_set_share_access": true,
        "can_share": true,
        "can_upload": true
      },
      "tags": [
        "approved"
      ],
      "can_non_owners_invite": true,
      "is_externally_owned": true,
      "is_collaboration_restricted_to_enterprise": true,
      "allowed_shared_link_access_levels": [
        "open"
      ],
      "allowed_invitee_roles": [
        "open"
      ],
      "watermark_info": {
        "is_watermarked": true
      },
      "can_non_owners_view_collaborators": true
    }