Box Get Metadata Template By NameBox ToolsRetrieves a metadata template by its `scope` and `templateKey` values. To find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Retention PolicyBox ToolsRetrieves a retention policy by its unique ID. Retention policies define how long content is retained before being automatically deleted or having the retention removed. This is an enterprise-level feature that requires the 'manage_data_retention' OAuth scope to be enabled. Retu…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Retention Policy AssignmentBox ToolsRetrieves a retention policy assignment by its unique ID. A retention policy assignment represents a link between a retention policy and its target (a folder, the enterprise, or a metadata template). This action returns details about where and how the retention policy is applied…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shared Link For FileBox ToolsRetrieves the shared link information for a file. This action fetches details about an existing shared link, including the URL, access level, permissions, and usage statistics. If the file does not have a shared link, the shared_link field in the response will be null.Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shared Link For FolderBox ToolsRetrieves shared link information for a folder. This action fetches the shared link details for a specified folder, including the public URL, access level, permissions, and usage statistics. If the folder does not have a shared link, the 'shared_link' field in the response will…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shared Web LinkBox ToolsTool to retrieve web link information for a shared link. Use when you have a Box shared link URL and need to get details about the web link object it points to.Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shield Information Barrier By IdBox ToolsRetrieves a shield information barrier by its unique ID. Shield information barriers are used to separate individuals/groups within the same enterprise and prevent confidential information from passing between them. Note: This feature requires Box Shield enterprise licensing. Re…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shield Information Barrier Report By IdBox ToolsRetrieves a shield information barrier report by its ID. Shield information barrier reports provide information about users and groups that are affected by shield information barriers in the enterprise. Reports include details about which users are in which segments and any poli…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shield Information Barrier Segment By IdBox ToolsRetrieves a shield information barrier segment by its unique identifier. Shield information barriers are used to prevent conflicts of interest by restricting communication between specific groups of users. Segments define groups of users within a barrier. Note: This feature requ…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shield Information Barrier Segment Member By IdBox ToolsRetrieves a shield information barrier segment member by its unique ID. Shield Information Barriers enforce compliance by restricting collaboration between departments (e.g., Investment Banking vs Research in financial institutions). Returns details about a user's segment assign…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Shield Information Barrier Segment Restriction By IdBox ToolsRetrieves a shield information barrier segment restriction by its unique ID. Shield information barrier segment restrictions define which segments cannot communicate or collaborate with each other. This action fetches the details of a specific restriction including the requestin…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Storage PolicyBox ToolsFetches a specific storage policy by its ID. Storage policies define the geographic location where content is stored (data residency). This is an enterprise feature that requires Box Zones or similar subscription. Use this action to get details about a storage policy, including…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Storage Policy AssignmentBox ToolsRetrieves information about a specific storage policy assignment. Storage policies control where data is physically stored (data residency). This action requires the Box Zones add-on or equivalent enterprise feature. Use 'list_storage_policy_assignments' to find assignment IDs f…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get TaskBox ToolsRetrieves detailed information about a specific task in Box. A task is a to-do item that can be assigned to users for a specific file. Tasks can be of type 'review' (approval workflow) or 'complete' (general task). Use this action to get task details including the associated fil…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Task AssignmentBox ToolsRetrieves detailed information about a specific task assignment in Box. A task assignment represents a task that has been assigned to a specific user. This endpoint returns information including: - The file associated with the task - The user the task is assigned to - The user w…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Terms Of ServiceBox ToolsRetrieves a specific terms of service by its unique identifier. Returns the full terms of service object including: - Status (enabled/disabled) - Terms text content - Type (managed users or external collaborators) - Associated enterprise information - Creation and modification t…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Trashed FileBox ToolsRetrieves a file that has been moved to the trash. Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Trashed FolderBox ToolsRetrieves a folder that has been moved to the trash. Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /fol…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Trashed Web LinkBox ToolsRetrieves a web link that has been moved to the trash. Returns detailed information about a trashed web link including its original URL, name, description, creator, when it was trashed, and when it will be permanently purged. The web link must exist in the trash (not permanently…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get Upload SessionBox ToolsRetrieves detailed information about an existing chunked upload session. Returns the session status including: - Total number of parts expected for the file upload - Size of each part in bytes - Number of parts already processed/uploaded - Session expiration timestamp - Availabl…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get UserBox ToolsRetrieves information about a user in the enterprise. The application and the authenticated user need to have the permission to look up users in the entire enterprise. This endpoint also returns a limited set of information for external users who are collaborated on content owne…Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get User AvatarBox ToolsRetrieves the avatar image of a Box user. Returns 404 if the user has no avatar set.Write Action·Risk level 2 of 5·OAuth connection·Free Action
Box Get User Exempt From Collaboration Domain RestrictionsBox ToolsRetrieves details of a specific user exemption from collaboration domain restrictions. This endpoint returns information about a user who has been granted an exemption from the enterprise's collaboration domain allowlist, allowing them to collaborate with external parties from a…Write Action·Risk level 2 of 5·OAuth connection·Free Action
