Retrieves details for a folder, including the first 100 entries in the folder. To fetch more items within the folder, please use the Get items in a folder endpoint.

​
Basic Parameters

ParameterDescription
Folder IDThe unique identifier that represent a folder.

​
Advanced Parameters

ParameterDescription
Box APIThe URL, and optional password, for the shared link of this item.
This header can be used to access items that have not been explicitly shared with a user.
Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password].
Ensure Item Has ChangedEnsures an item is only returned if it has changed. 0 - not changed, 1 - changed.
FieldsA 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.

​
Example Output

{
	"content_created_at": "2012-12-12T10:53:43-08:00",
	"content_modified_at": "2012-12-12T10:53:43-08:00",
	"created_at": "2012-12-12T10:53:43-08:00",
	"created_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"description": "Legal contracts for the new ACME deal",
	"etag": "1",
	"folder_upload_email": {
		"access": "open",
		"email": "upload.Contracts.asd7asd@u.box.com"
	},
	"id": "12345",
	"item_collection": {
		"entries": [
			{
				"etag": "1",
				"file_version": {
					"id": "12345",
					"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
					"type": "file_version"
				},
				"id": "12345",
				"name": "Contract.pdf",
				"sequence_id": "3",
				"sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
				"type": "file"
			}
		],
		"limit": 1000,
		"offset": 2000,
		"order": [
			{
				"by": "type",
				"direction": "ASC"
			}
		],
		"total_count": 5000
	},
	"item_status": "active",
	"modified_at": "2012-12-12T10:53:43-08:00",
	"modified_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"name": "Contracts",
	"owned_by": {
		"id": "11446498",
		"login": "ceo@example.com",
		"name": "Aaron Levie",
		"type": "user"
	},
	"parent": {
		"etag": "1",
		"id": "12345",
		"name": "Contracts",
		"sequence_id": "3",
		"type": "folder"
	},
	"path_collection": {
		"entries": [
			{
				"etag": "1",
				"id": "12345",
				"name": "Contracts",
				"sequence_id": "3",
				"type": "folder"
			}
		],
		"total_count": 1
	},
	"purged_at": "2012-12-12T10:53:43-08:00",
	"sequence_id": "3",
	"shared_link": {
		"access": "open",
		"download_count": 3,
		"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
		"effective_access": "company",
		"effective_permission": "can_download",
		"is_password_enabled": true,
		"permissions": {
			"can_download": true,
			"can_edit": false,
			"can_preview": true
		},
		"preview_count": 3,
		"unshared_at": "2018-04-13T13:53:23-07:00",
		"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
		"vanity_name": "my_url",
		"vanity_url": "https://acme.app.box.com/v/my_url/"
	},
	"size": 629644,
	"trashed_at": "2012-12-12T10:53:43-08:00",
	"type": "folder"
}

​
Workflow Library Example

Get Folder Information with Box and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop