Get Items From Folder
Retrieves a page of items in a folder. These items can be files, folders, and web links.
To request more information about the folder itself, like its size, please use the Get a folder endpoint instead.
Basic Parameters
Parameter | Description |
---|---|
Folder ID | The unique identifier that represent a folder. |
Advanced Parameters
Parameter | Description |
---|---|
Box API | The 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]. |
Direction | The direction to sort results in. This can be either in alphabetical ascending (ASC ) or descending (DESC ) order. |
Fields | 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. |
Limit | The maximum number of items to return per page. |
Offset | The offset of the item at which to begin the response. |
Sort | Defines 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