The Box List component allows you to retrieve a list of files from Box.
| Output Payload | Description |
|---|---|
cv.Payload |
Outputs the file list |
Example of the output Payload for Box List
{
"Filename": "test.txt",
"ID": "1365057753092",
"IsDir": false,
"ModifiedTime": "2023-11-17T01:20:35-08:00",
"ParentFolderID": "235207463831",
"Path": "a/b/test.txt",
"Size": 6
}Component Properties
| Property Name | Description |
|---|---|
| Box Folder Path | Specify the Box folder path for download |
| Search Target | Specify the file name to search |
| Search Type | Specify the method of searching the ‘Search Target’, either exact match or partial match for the file name |
| Include Files | Include files in the search results |
| Include Directories | Include directories in the search results |
| Sort Order | Specify the output order of the search results, such as file name (ascending), file name (descending), modified time (ascending), modified time (descending), file size (ascending), file size (descending) |
| Files Added or Changed Today | Specify files that were added or updated on the day of execution |
| Retrieve Files Changed After This Time | Download files changed after the specified time |
| Retrieve Files Changed Before This Time | Download files changed before the specified time |
| Timeout | HTTP request response timeout value |
| Time Zone | Specify the time zone for the time used in ‘Files Added or Changed Today’ |
| OAuth2 Client ID | Specify the Client ID for API 2.0 from Box ※1 |
| OAuth2 Client Secret | Specify the Client Secret from Box ※1 |
| OAuth2 Redirect URL | Specify the Redirect URL from Box ※1 |
| OAuth2 Access Token | Obtain the token by pressing the ‘Get Token’ button. You can also update the token by pressing the ‘Update Token’ button ※1 ※2 |
※1 For an example of OAuth2 settings in Box, refer to here
How to obtain the OAuth2 Access Token is detailed here
Need more help with this?
Join our slack community for help