To request more information about the folder itself, like its size, please use the Get a folder endpoint instead.

​
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 sharedlink=[link] or if a password is required then use sharedlink=[link]&sharedlinkpassword=[password].
DirectionThe direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
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.
LimitThe maximum number of items to return per page.
OffsetThe offset of the item at which to begin the response.
SortDefines the second attribute by which items are sorted.

​
Example Output​

{    "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}

​
Workflow Library Example​

Get Items from Folder with Box and Send Results Via Email

Preview this Workflow on desktop

Was this page helpful?

Get Folder InformationGet Shared Link Information