BOX_ADD_CLASSIFICATION_TO_FILE
Adds a classification to a file by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.
BOX_ADD_CLASSIFICATION_TO_FOLDER
Adds a classification to a folder by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.
BOX_ADD_DOMAIN_TO_LIST_OF_ALLOWED_COLLABORATION_DOMAINS
Creates a new entry in the list of allowed domains to allow collaboration for.
BOX_ADD_INITIAL_CLASSIFICATIONS
When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.
BOX_ADD_OR_UPDATE_USER_AVATAR
Adds or updates a user avatar.
BOX_ADD_SHARED_LINK_TO_FILE
Adds a shared link to a file.
BOX_ADD_SHARED_LINK_TO_FOLDER
Adds a shared link to a folder.
BOX_ADD_SHARED_LINK_TO_WEB_LINK
Adds a shared link to a web link.
BOX_ADD_USER_TO_GROUP
Creates a group membership. Only users with admin-level permissions will be able to use this API.
BOX_APPLY_WATERMARK_TO_FILE
Applies or update a watermark on a file.
BOX_APPLY_WATERMARK_TO_FOLDER
Applies or update a watermark on a folder.
BOX_ASK_QUESTION
Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.
BOX_ASSIGN_LEGAL_HOLD_POLICY
Assign a legal hold to a file, file version, folder, or user.
BOX_ASSIGN_RETENTION_POLICY
Assigns a retention policy to an item.
BOX_ASSIGN_STORAGE_POLICY
Creates a storage policy assignment for an enterprise or user.
BOX_ASSIGN_TASK
Assigns a task to a user. A task can be assigned to more than one user by creating multiple assignments.
BOX_AUTHORIZE_USER
Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.
BOX_CANCEL_BOX_SIGN_REQUEST
Cancels a sign request.
BOX_CHANGE_SHIELD_INFORMATION_BARRIER_STATUS
Change status of shield information barrier with the specified ID.
BOX_COMMIT_UPLOAD_SESSION
Close an upload session and create a file from the uploaded chunks. The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
BOX_COPY_FILE
Creates a copy of a file.
BOX_COPY_FILE_REQUEST
Copies an existing file request that is already present on one folder, and applies it to another folder.
BOX_COPY_FOLDER
Creates a copy of a folder within a destination folder. The original folder will not be changed.
BOX_CREATE_AI_AGENT
Creates an AI agent. At least one of the following capabilities must be provided: `ask`, `text_gen`, `extract`.
BOX_CREATE_BOX_SIGN_REQUEST
Creates a signature request. This involves preparing a document for signing and sending the signature request to signers.
BOX_CREATE_BOX_SKILL_CARDS_ON_FILE
Applies one or more Box Skills metadata cards to a file.
BOX_CREATE_COLLABORATION
Adds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited. If collaboration is in `pending` status, the following fields are redacted: - `login` and `name` are hidden if a collaboration was created using `user_id`, - `name` is hidden if a collaboration was created using `login`.
BOX_CREATE_COMMENT
Adds a comment by the user to a specific file, or as a reply to an other comment.
BOX_CREATE_EMAIL_ALIAS
Adds a new email alias to a user account..
BOX_CREATE_FOLDER
Creates a new empty folder within the specified parent folder.
BOX_CREATE_FOLDER_LOCK
Creates a folder lock on a folder, preventing it from being moved and/or deleted. You must be authenticated as the owner or co-owner of the folder to use this endpoint.
BOX_CREATE_GROUP
Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.
BOX_CREATE_JOBS_TO_TERMINATE_USER_GROUP_SESSION
Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.
BOX_CREATE_JOBS_TO_TERMINATE_USERS_SESSION
Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.
BOX_CREATE_LEGAL_HOLD_POLICY
Create a new legal hold policy.
BOX_CREATE_METADATA_CASCADE_POLICY
Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.
BOX_CREATE_METADATA_INSTANCE_ON_FILE
Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.
BOX_CREATE_METADATA_INSTANCE_ON_FOLDER
Applies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair. To display the metadata template in the Box web app the enterprise needs to be configured to enable **Cascading Folder Level Metadata** for the user in the admin console.
BOX_CREATE_METADATA_TEMPLATE
Creates a new metadata template that can be applied to files and folders.
BOX_CREATE_RETENTION_POLICY
Creates a retention policy.
BOX_CREATE_SHIELD_INFORMATION_BARRIER
Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORT
Creates a shield information barrier report for a given barrier.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT
Creates a shield information barrier segment.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER
Creates a new shield information barrier segment member.
BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION
Creates a shield information barrier segment restriction object.
BOX_CREATE_SLACK_INTEGRATION_MAPPING
Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
BOX_CREATE_TASK
Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately.
BOX_CREATE_TEAMS_INTEGRATION_MAPPING
Creates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
BOX_CREATE_TERMS_OF_SERVICE
Creates a terms of service for a given enterprise and type of user.
BOX_CREATE_TERMS_OF_SERVICE_STATUS_FOR_NEW_USER
Sets the status for a terms of service for a user.
BOX_CREATE_UPLOAD_SESSION
Creates an upload session for a new file.
BOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILE
Creates an upload session for an existing file.
BOX_CREATE_USER
Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
BOX_CREATE_USER_EXEMPTION_FROM_COLLABORATION_DOMAIN_RESTRICTIONS
Create user exemption from collaboration domain restrictions.
BOX_CREATE_USER_INVITE
Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.
BOX_CREATE_WEBHOOK
Creates a webhook.
BOX_CREATE_WEB_LINK
Creates a web link object within a folder.
BOX_CREATE_ZIP_DOWNLOAD
Creates a request to download multiple files and folders as a single `zip` archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download_url` and a `status_url` that can be used to download the archive. The limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first. **Note**: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.
BOX_DELETE_AI_AGENT
Deletes an AI agent using the provided parameters.
BOX_DELETE_FILE
Deletes a file, either permanently or by moving it to the trash. The the enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.
BOX_DELETE_FILE_REQUEST
Deletes a file request permanently.
BOX_DELETE_FOLDER
Deletes a folder, either permanently or by moving it to the trash.
BOX_DELETE_FOLDER_LOCK
Deletes a folder lock on a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.
BOX_DELETE_RETENTION_POLICY
Permanently deletes a retention policy.
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT
Deletes the shield information barrier segment based on provided ID.
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID
Deletes a shield information barrier segment member based on provided ID.
BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_ID
Delete shield information barrier segment restriction by ID.
BOX_DELETE_SLACK_INTEGRATION_MAPPING
Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). You need Admin or Co-Admin role to use this endpoint.
BOX_DELETE_TEAMS_INTEGRATION_MAPPING
Deletes a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams). You need Admin or Co-Admin role to use this endpoint.
BOX_DELETE_USER
Deletes a user. By default this will fail if the user still owns any content. Move their owned content first before proceeding, or use the `force` field to delete the user and their files.
BOX_DELETE_USER_AVATAR
Removes an existing user avatar. You cannot reverse this operation.
BOX_DOWNLOAD_FILE
Returns the contents of a file in binary format.
BOX_DOWNLOAD_ZIP_ARCHIVE
Returns the contents of a `zip` archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device. By default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created. The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](e://post_zip_downloads) API to request to create a `zip` archive, and then follow the `download_url` field in the response to this endpoint.
BOX_EXTRACT_METADATA_FREEFORM
Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. In this request, both the prompt and the output can be freeform. Metadata template setup before sending the request is not required.
BOX_EXTRACT_METADATA_STRUCTURED
Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. For this request, you either need a metadata template or a list of fields you want to extract. Input is **either** a metadata template or a list of fields to ensure the structure. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates) or use the [metadata template API](g://metadata/templates/create).
BOX_FIND_APP_ITEM_FOR_SHARED_LINK
Returns the app item represented by a shared link. The link can originate from the current enterprise or another.
BOX_FIND_FILE_FOR_SHARED_LINK
Returns the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared file when only given a shared link. The `shared_link_permission_options` array field can be returned by requesting it in the `fields` query parameter.
BOX_FIND_FOLDER_FOR_SHARED_LINK
Return the folder represented by a shared link. A shared folder can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared folder when only given a shared link. Conditional parameter requirements: - To retrieve the folder, you must supply a valid shared link via either the `shared_link` field (recommended) or the `boxapi` header string. If the shared link is password-protected, also provide `shared_link_password`.
BOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_ID
Finds a metadata template by searching for the ID of an instance of the template.
BOX_FIND_WEB_LINK_FOR_SHARED_LINK
Returns the web link represented by a shared link. A shared web link can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared web link when only given a shared link.
BOX_FORCE_APPLY_METADATA_CASCADE_POLICY_TO_FOLDER
Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.
BOX_GENERATE_TEXT
Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.
BOX_GET_AI_AGENT_BY_AGENT_ID
Gets an AI Agent using the `agent_id` parameter.
BOX_GET_AI_AGENT_DEFAULT_CONFIGURATION
Get the AI agent default config
BOX_GET_ALLOWED_COLLABORATION_DOMAIN
Returns a domain that has been deemed safe to create collaborations for within the current enterprise.
BOX_GET_BOX_SIGN_REQUEST_BY_ID
Gets a sign request by ID.
BOX_GET_BOX_SIGN_TEMPLATE_BY_ID
Fetches details of a specific Box Sign template.
BOX_GET_CLASSIFICATION_ON_FILE
Retrieves the classification metadata instance that has been applied to a file. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.
BOX_GET_CLASSIFICATION_ON_FOLDER
Retrieves the classification metadata instance that has been applied to a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.
BOX_GET_COLLABORATION
Retrieves a single collaboration.
BOX_GET_COLLECTION_BY_ID
Retrieves a collection by its ID.
BOX_GET_COMMENT
Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
BOX_GET_CURRENT_USER
Retrieves information about the user who is currently authenticated. In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app. In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default. Use the `As-User` header to change who this API call is made on behalf of.
BOX_GET_DEVICE_PIN
Retrieves information about an individual device pin.
BOX_GET_EVENTS_LONG_POLL_ENDPOINT
The ListEvents endpoint provides information about the events available in the Box system. This OPTIONS method allows developers to discover the capabilities and requirements for interacting with the /events endpoint. It's particularly useful for understanding the types of events that can be monitored, the format of event data, and any constraints or limitations on event retrieval. This endpoint should be used when setting up event monitoring or webhook integrations to ensure proper configuration and understanding of the event system. While it doesn't directly fetch events, it offers crucial metadata for effectively working with Box's event streaming and notification features.
BOX_GET_FILE_INFORMATION
Retrieves the details about a file.
BOX_GET_FILE_REQUEST
Retrieves the information about a file request.
BOX_GET_FILES_UNDER_RETENTION
Returns a list of files under retention for a retention policy assignment.
BOX_GET_FILE_THUMBNAIL
Retrieves a thumbnail, or smaller image representation, of a file. Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format. Thumbnails can be generated for the image and video file formats listed [found on our community site][1]. [1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327
BOX_GET_FILE_VERSION
Retrieve a specific version of a file. Versions are only tracked for Box users with premium accounts.
BOX_GET_FILE_VERSION_LEGAL_HOLD
Retrieves information about the legal hold policies assigned to a file version.
BOX_GET_FILE_VERSIONS_UNDER_RETENTION
Returns a list of file versions under retention for a retention policy assignment.
BOX_GET_FOLDER_INFORMATION
Retrieves details for a folder, including the first 100 entries in the folder. Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](r://folder--full#param-item-collection). To fetch more items within the folder, use the [Get items in a folder](e://get-folders-id-items) endpoint.
BOX_GET_GROUP
Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.
BOX_GET_GROUP_MEMBERSHIP
Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
BOX_GET_LEGAL_HOLD_POLICY
Retrieve a legal hold policy.
BOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENT
Retrieve a legal hold policy assignment.
BOX_GET_METADATA_CASCADE_POLICY
Retrieve a specific metadata cascade policy assigned to a folder.
BOX_GET_METADATA_INSTANCE_ON_FILE
Retrieves the instance of a metadata template that has been applied to a file.
BOX_GET_METADATA_INSTANCE_ON_FOLDER
Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.
BOX_GET_METADATA_TEMPLATE_BY_ID
Retrieves a metadata template by its ID.
BOX_GET_METADATA_TEMPLATE_BY_NAME
Retrieves 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.
BOX_GET_RETENTION_ON_FILE
Returns information about a file version retention. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
BOX_GET_RETENTION_POLICY
Retrieves a retention policy.
BOX_GET_RETENTION_POLICY_ASSIGNMENT
Retrieves a retention policy assignment
BOX_GET_SHARED_LINK_FOR_FILE
Gets the information for a shared link on a file.
BOX_GET_SHARED_LINK_FOR_FOLDER
Gets the information for a shared link on a folder.
BOX_GET_SHARED_LINK_FOR_WEB_LINK
Gets the information for a shared link on a web link.
BOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_ID
Retrieves a shield information barrier report by its ID.
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID
Retrieves a shield information barrier segment member by its ID.
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_ID
Retrieves a shield information barrier segment restriction based on provided ID.
BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_WITH_SPECIFIED_ID
Retrieves shield information barrier segment based on provided ID..
BOX_GET_SHIELD_INFORMATION_BARRIER_WITH_SPECIFIED_ID
Get shield information barrier based on provided ID.
BOX_GET_STORAGE_POLICY
Fetches a specific storage policy.
BOX_GET_STORAGE_POLICY_ASSIGNMENT
Fetches a specific storage policy assignment.
BOX_GET_TASK
Retrieves information about a specific task.
BOX_GET_TASK_ASSIGNMENT
Retrieves information about a task assignment.
BOX_GET_TERMS_OF_SERVICE
Fetches a specific terms of service.
BOX_GET_TRASHED_FILE
Retrieves 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/:id/trash`](e://get_folders_id_trash) API. To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](e://get-folders-trash-items/) API.
BOX_GET_TRASHED_FOLDER
Retrieves 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 /folders/:id/trash`](e://get_folders_id_trash) API. To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](e://get-folders-trash-items/) API.
BOX_GET_TRASHED_WEB_LINK
Retrieves a web link that has been moved to the trash.
BOX_GET_UPLOAD_SESSION
Return information about an upload session. The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.
BOX_GET_USER
Retrieves 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 owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.
BOX_GET_USER_AVATAR
Retrieves an image of a the user's avatar.
BOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS
Returns a users who has been exempt from the collaboration domain restrictions.
BOX_GET_USER_INVITE_STATUS
Returns the status of a user invite.
BOX_GET_WATERMARK_FOR_FOLDER
Retrieve the watermark for a folder.
BOX_GET_WATERMARK_ON_FILE
Retrieve the watermark for a file.
BOX_GET_WEBHOOK
Retrieves a specific webhook
BOX_GET_WEB_LINK
Retrieve information about a web link.
BOX_GET_ZIP_DOWNLOAD_STATUS
Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. This endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download. The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](e://post_zip_downloads) API to request to create a `zip` archive, and then follow the `status_url` field in the response to this endpoint.
BOX_LIST_AI_AGENTS
Lists AI agents based on the provided parameters.
BOX_LIST_ALL_CLASSIFICATIONS
Retrieves the classification metadata template and lists all the classifications available to this enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.
BOX_LIST_ALL_COLLECTIONS
Retrieves all collections for a given user. Currently, only the `favorites` collection is supported.
BOX_LIST_ALL_FILE_VERSIONS
Retrieve a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.
BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATES
Used to retrieve all generic, global metadata templates available to all enterprises using Box.
BOX_LIST_ALL_LEGAL_HOLD_POLICIES
Retrieves a list of legal hold policies that belong to an enterprise.
BOX_LIST_ALL_METADATA_TEMPLATES_FOR_ENTERPRISE
Used to retrieve all metadata templates created to be used specifically within the user's enterprise
BOX_LIST_ALLOWED_COLLABORATION_DOMAINS
Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.
BOX_LIST_ALL_WEBHOOKS
Returns all defined webhooks for the requesting application. This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.
BOX_LIST_BOX_SIGN_REQUESTS
Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.
BOX_LIST_BOX_SIGN_TEMPLATES
Gets Box Sign templates created by a user.
BOX_LIST_BOX_SKILL_CARDS_ON_FILE
List the Box Skills metadata cards that are attached to a file.
BOX_LIST_COLLECTION_ITEMS
Retrieves the files and/or folders contained within this collection.
BOX_LIST_ENTERPRISE_DEVICE_PINS
Retrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.
BOX_LIST_ENTERPRISE_USERS
Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`. The application and the authenticated user need to have the permission to look up users in the entire enterprise.
BOX_LIST_FILE_APP_ITEM_ASSOCIATIONS
**This is a beta feature, which means that its availability might be limited.** Returns all app items the file is associated with. This includes app items associated with ancestors of the file. Assuming the context user has access to the file, the type/ids are revealed even if the context user does not have **View** permission on the app item.
BOX_LIST_FILE_COLLABORATIONS
Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.
BOX_LIST_FILE_COMMENTS
Retrieves a list of comments for a file.
BOX_LIST_FILE_VERSION_LEGAL_HOLDS
Get a list of file versions on legal hold for a legal hold assignment. Due to ongoing re-architecture efforts this API might not return all file versions for this policy ID. Instead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture. For file versions held in the new architecture, the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to return all past file versions available for this policy assignment, and the `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to return any current (latest) versions of a file under legal hold. The `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID. Once the re-architecture is completed this API will be deprecated.
BOX_LIST_FILE_VERSION_RETENTIONS
Retrieves all file version retentions for the given enterprise. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONS
**This is a beta feature, which means that its availability might be limited.** Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have **View** permission on the app item.
BOX_LIST_FOLDER_COLLABORATIONS
Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.
BOX_LIST_FOLDER_LOCKS
Retrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.
BOX_LIST_GROUP_COLLABORATIONS
Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. Each collaboration object has details on which files or folders the group has access to and with what role.
BOX_LIST_GROUPS_FOR_ENTERPRISE
Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.
BOX_LIST_ITEMS_IN_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, use the [Get a folder](#get-folders-id) endpoint instead.
BOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTS
Retrieves a list of items a legal hold policy has been assigned to.
BOX_LIST_MEMBERS_OF_GROUP
Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.
BOX_LIST_METADATA_CASCADE_POLICIES
Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.
BOX_LIST_METADATA_INSTANCES_ON_FILE
Retrieves all metadata for a given file.
BOX_LIST_METADATA_INSTANCES_ON_FOLDER
Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.
BOX_LIST_PARTS
Return a list of the chunks uploaded to the upload session so far. The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.
BOX_LIST_PENDING_COLLABORATIONS
Retrieves all pending collaboration invites for this user.
BOX_LIST_PREVIOUS_FILE_VERSIONS_FOR_LEGAL_HOLD_POLICY_ASSIGNMENT
List previous file versions for legal hold policy assignment
BOX_LIST_RECENTLY_ACCESSED_ITEMS
Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.
BOX_LIST_RETENTION_POLICIES
Retrieves all of the retention policies for an enterprise.
BOX_LIST_RETENTION_POLICY_ASSIGNMENTS
Returns a list of all retention policy assignments associated with a specified retention policy.
BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTS
Lists shield information barrier reports.
BOX_LIST_SHIELD_INFORMATION_BARRIERS
Retrieves a list of shield information barrier objects for the enterprise of JWT.
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERS
Lists shield information barrier segment members based on provided segment IDs.
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONS
Lists shield information barrier segment restrictions based on provided segment ID.
BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTS
Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.
BOX_LIST_SLACK_INTEGRATION_MAPPINGS
Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
BOX_LIST_STORAGE_POLICIES
Fetches all the storage policies in the enterprise.
BOX_LIST_STORAGE_POLICY_ASSIGNMENTS
Fetches all the storage policy assignment for an enterprise or user.
BOX_LIST_TASK_ASSIGNMENTS
Lists all of the assignments for a given task.
BOX_LIST_TASKS_ON_FILE
Retrieves a list of all the tasks for a file. This endpoint does not support pagination.
BOX_LIST_TEAMS_INTEGRATION_MAPPINGS
Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
BOX_LIST_TERMS_OF_SERVICES
Returns the current terms of service text and settings for the enterprise.
BOX_LIST_TERMS_OF_SERVICE_USER_STATUSES
Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.
BOX_LIST_TRASHED_ITEMS
Retrieves the files and folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the `fields` parameter to retrieve those specific attributes that are not returned by default. This endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the `marker` parameter.
BOX_LIST_USER_AND_ENTERPRISE_EVENTS
Returns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.
BOX_LIST_USER_S_EMAIL_ALIASES
Retrieves all email aliases for a user. The collection does not include the primary login for the user.
BOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS
Returns a list of users who have been exempt from the collaboration domain restrictions.
BOX_LIST_USER_S_GROUPS
Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.
BOX_LIST_WORKFLOWS
Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in to use this endpoint.
BOX_PERMANENTLY_REMOVE_FILE
Permanently deletes a file that is in the trash. This action cannot be undone.
BOX_PERMANENTLY_REMOVE_FOLDER
Permanently deletes a folder that is in the trash. This action cannot be undone.
BOX_PERMANENTLY_REMOVE_WEB_LINK
Permanently deletes a web link that is in the trash. This action cannot be undone.