Box

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`.

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`.

Creates a new entry in the list of allowed domains to allow collaboration for.

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.

Adds or updates a user avatar.

Adds a shared link to a file.

Adds a shared link to a folder.

Adds a shared link to a web link.

Creates a group membership. only users with admin-level permissions will be able to use this api.

Applies or update a watermark on a file.

Applies or update a watermark on a folder.

Sends an ai request to supported llms and returns an answer specifically focused on the user's question given the provided context.

Assign a legal hold to a file, file version, folder, or user.

Assigns a retention policy to an item.

Creates a storage policy assignment for an enterprise or user.

Assigns a task to a user. a task can be assigned to more than one user by creating multiple assignments.

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.

Cancels a sign request.

Change status of shield information barrier with the specified id.

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.

Creates a copy of a file.

Copies an existing file request that is already present on one folder, and applies it to another folder.

Creates a copy of a folder within a destination folder. the original folder will not be changed.

Creates an ai agent. at least one of the following capabilities must be provided: `ask`, `text gen`, `extract`.

Creates a signature request. this involves preparing a document for signing and sending the signature request to signers.

Applies one or more box skills metadata cards to a file.

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`.

Create user exemption from collaboration domain restrictions.

Adds a comment by the user to a specific file, or as a reply to an other comment.

Adds a new email alias to a user account..

Creates a new empty folder within the specified parent folder.

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.

Creates a new group of users in an enterprise. only users with admin permissions can create new groups.

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.

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.

Create a new legal hold 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.

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.

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.

Creates a new metadata template that can be applied to files and folders.

Creates a retention policy.

Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Creates a shield information barrier report for a given barrier.

Creates a shield information barrier segment.

Creates a new shield information barrier segment member.

Creates a shield information barrier segment restriction object.

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.

Creates a single task on a file. this task is not assigned to any user and will need to be assigned separately.

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.

Creates a terms of service for a given enterprise and type of user.

Sets the status for a terms of service for a user.

Creates an upload session for a new file.

Creates an upload session for an existing file.

Creates a new managed user in an enterprise. this endpoint is only available to users and applications with the right admin permissions.

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.

Creates a webhook.

Creates a web link object within a folder.

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.

Deletes an ai agent using the provided parameters.

Delete shield information barrier segment restriction by id.

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.

Deletes a file request permanently.

Deletes a folder, either permanently or by moving it to the trash.

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.

Permanently deletes a retention policy.

Deletes the shield information barrier segment based on provided id.

Deletes a shield information barrier segment member based on provided id.

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.

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.

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.

Removes an existing user avatar. you cannot reverse this operation.

Returns the contents of a file in binary format.

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.

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.

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).

Returns the app item represented by a shared link. the link can originate from the current enterprise or another.

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.

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.

Finds a metadata template by searching for the id of an instance of the template.

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.

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.

Sends an ai request to supported large language models (llms) and returns generated text based on the provided prompt.

Gets an ai agent using the `agent id` parameter.

Get the ai agent default config

Returns a domain that has been deemed safe to create collaborations for within the current enterprise.

Gets a sign request by id.

Fetches details of a specific box sign template.

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`.

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`.

Retrieves a single collaboration.

Retrieves a collection by its id.

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

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.

Retrieves information about an individual device pin.

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.

Returns a list of files under retention for a retention policy assignment.

Retrieves the details about a file.

Retrieves the information about a file request.

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

Retrieve a specific version of a file. versions are only tracked for box users with premium accounts.

Returns a list of file versions under retention for a retention policy assignment.

Retrieves information about the legal hold policies assigned to a file version.

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.

Retrieves information about a group. only members of this group or users with admin-level permissions will be able to use this api.

Retrieves a specific group membership. only admins of this group or users with admin-level permissions will be able to use this api.

Retrieve a legal hold policy.

Retrieve a legal hold policy assignment.

Retrieve a specific metadata cascade policy assigned to a folder.

Retrieves the instance of a metadata template that has been applied to a file.

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`.

Retrieves a metadata template by its id.

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.

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.

Retrieves a retention policy.

Retrieves a retention policy assignment

Gets the information for a shared link on a file.

Gets the information for a shared link on a folder.

Gets the information for a shared link on a web link.

Retrieves a shield information barrier report by its id.

Retrieves a shield information barrier segment member by its id.

Retrieves a shield information barrier segment restriction based on provided id.

Retrieves shield information barrier segment based on provided id..

Get shield information barrier based on provided id.

Fetches a specific storage policy.

Fetches a specific storage policy assignment.

Retrieves information about a specific task.

Retrieves information about a task assignment.

Fetches a specific terms of service.

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.

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.

Retrieves a web link that has been moved to the trash.

Return information about an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) endpoint.

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.

Retrieves an image of a the user's avatar.

Returns a users who has been exempt from the collaboration domain restrictions.

Returns the status of a user invite.

Retrieve the watermark for a folder.

Retrieve the watermark for a file.

Retrieves a specific webhook

Retrieve information about a web link.