Home > Application Reference > Box > Search Folders

Search folders in Box by using filters.

Required fields are indicated by a red asterisk on the Action Card.

Options

  • Result Set (drop-down list): filter results by
    • First matching record: return the first folder to match the search parameters
    • All matching records: return all folders that match the search parameters

Input

Search By * Name (text): name of the folder * Start Date (text): start date of a created at range (End Date must be used in conjunction) * End Date (text): end date of a created at range (Start Date must be used in conjunction) * User ID (text): name of the user who created the folder * Parent ID (text): unique identifier of the parent folder

Output

Result

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