Search Folders

Search folders in Box by using filters.

Options

Field Definition Type Required
Result Set filter results by drop-down list FALSE
First matching record return the first folder to match the search parameters String FALSE
All matching records return all folders that match the search parameters String FALSE

Input

Field Definition Type Required
Search By
Name name of the folder String FALSE
Start Date start date of a created at range (End Date must be used in conjunction) String FALSE
End Date end date of a created at range (Start Date must be used in conjunction) String FALSE
User ID name of the user who created the folder String FALSE
Parent ID unique identifier of the parent folder String FALSE

Output

Field Definition Type
Folders
Name name of the folder String
Description description of the folder String
Version Tag version tag of the file (tracked for Box users with premium accounts only) String
Sequence ID unique identifier for use with events endpoint String
Size size of the folder String
Path path to the folder (for example, /pictures/2016/4/…) String
Time Created timestamp when the folder was created in Box String
Time Modified timestamp when the folder was modified in Box String
Time Trashed timestamp when the folder was trashed in Box String
Time Purged timestamp when the folder was purged in Box String
Time Content Created timestamp when the folder was originally created String
Folder Upload Email email from which the folder was uploaded String
Parent Folder Name name of the folder’s parent folder String
Parent Folder ID unique identifier of the folder’s parent folder String
Item Status status of the item (active, trashed, or deleted) String
Sync State the synchronization state of this folder String
Tags tags on this folder List
Share Link
Share URL URL to view the folder String
Download URL URL to download the folder String
Vanity URL customizable URL String
Password Enabled indicator of password Boolean
Time Unshared timestamp when the folder was unshared String
Download Count number of times the folder was downloaded Number
Preview Count number of times the folder was previewed Number
Access Level accessibility of the share link (for example, Edit or View) String
Can Download indicator of downloadable content Boolean
Can Preview indicator of viewable content Boolean
Permissions
Can Non-Owners Invite indicator if non-owners can send invitations to this folder Boolean
Is Externally Owned indicator if the folder is externally owned Boolean
Allowed Link Access Levels user levels that can share link access List
Allowed Invitee Roles roles that can invite List
Has Collaborations indicator if the folder allows collaboration Boolean
Created By
Name name of the user who created the folder String
User ID unique identifier of the user String
Email email address of the user String
Modified By
Name name of the user who most recently modified the folder String
User ID unique identifier of the user String
Email email address of the user String
Owned By
Name name of the user who owns the folder String
User ID unique identifier of the owner String
Email email address of the owner String

Related topics

Box connector

About the elements of Okta Workflows

Box API