Get File Information

To get a file’s information, not it’s content, call the API with the id of the file.

cURL

curl -i -X GET "https://api.box.com/2.0/files/12345" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

await client.files.getFileById(uploadedFile.id, {
  queryParams: {
    fields: ['is_externally_owned', 'has_collaborations'],
  } satisfies GetFileByIdQueryParams,
} satisfies GetFileByIdOptionalsInput);

client.files.get_file_by_id(
    uploaded_file.id, fields=["is_externally_owned", "has_collaborations"]
)

await client.Files.GetFileByIdAsync(fileId: uploadedFile.Id, queryParams: new GetFileByIdQueryParams() { Fields = Array.AsReadOnly(new [] {"is_externally_owned","has_collaborations"}) });

try await client.files.getFileById(fileId: uploadedFile.id, queryParams: GetFileByIdQueryParams(fields: ["is_externally_owned", "has_collaborations"]))

client.getFiles().getFileById(uploadedFile.getId(), new GetFileByIdQueryParams.Builder().fields(Arrays.asList("is_externally_owned", "has_collaborations")).build())

BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.getInfo();

file_id = '11111'
file_info = client.file(file_id).get()
print(f'File "{file_info.name}" has a size of {file_info.size} bytes')

BoxFile file = await client.FilesManager.GetInformationAsync(id: "11111");

client.files.get('11111')
	.then(file => {
		/* file -> {
			type: 'file',
			id: '11111',
			file_version: 
			{ type: 'file_version',
				id: '22222',
				sha1: '97b3dbba6eab7ad0f058240744c8636b7c7bea93' },
			sequence_id: '1',
			etag: '1',
			sha1: '97b3dbba6eab7ad0f058240744c8636b7c7bea93',
			name: 'Puppy.png',
			description: '',
			size: 106833,
			path_collection: 
			{ total_count: 2,
				entries: 
				[ { type: 'folder',
					id: '0',
					sequence_id: null,
					etag: null,
					name: 'All Files' },
					{ type: 'folder',
					id: '33333',
					sequence_id: '0',
					etag: '0',
					name: 'Collaborated Folder' } ] },
			created_at: '2016-11-16T22:01:44-08:00',
			modified_at: '2016-11-16T22:01:51-08:00',
			trashed_at: null,
			purged_at: null,
			content_created_at: '2016-10-29T18:33:50-07:00',
			content_modified_at: '2016-10-29T18:33:50-07:00',
			created_by: 
			{ type: 'user',
				id: '44444',
				name: 'Owner',
				login: '[e-mail]' },
			modified_by: 
			{ type: 'user',
				id: '44444',
				name: 'Owner',
				login: '[e-mail]' },
			owned_by: 
			{ type: 'user',
				id: '44444',
				name: 'Owner',
				login: '[e-mail]' },
			shared_link: null,
			parent: 
			{ type: 'folder',
				id: '33333',
				sequence_id: '0',
				etag: '0',
				name: 'Collaborated Folder' },
			item_status: 'active' }

		*/
	});

File ID

The id for any file can be determined by visiting a file in the web application and copying the id from the URL. For example, for the URL https://*.app.box.com/file/123 the file_id is 123.

Additional fields

To get more of the fields for a file, make sure to pass along the fields query parameter.

Learn about requesting extra fields