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//enterpr

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/ente

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, t

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 r

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://

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 gr

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 group, and creates asynchronous jobs to terminate the group's sessions. returns the status for the post request.

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.

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

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 an

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

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 r

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

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.

Create user exemption from collaboration domain restrictions.

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 a

Creates a web link object within a folder.

Creates a webhook.

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

Deletes an ai agent using the provided parameters.

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.

Delete shield information barrier segment restriction by 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 defa

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

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

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 applicati

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 applic

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 a

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

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 12

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

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

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

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

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

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

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

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

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

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 app

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:

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

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

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 lim

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.

Retrieve information about a web link.

Retrieves a specific webhook

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 a

Lists ai agents based on the provided parameters.

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 exa

Retrieves all collections for a given user. currently, only the `favorites` collection is supported.

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.

Used to retrieve all generic, global metadata templates available to all enterprises using box.

Retrieves a list of legal hold policies that belong to an enterprise.

Used to retrieve all metadata templates created to be used specifically within the user's enterprise

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

Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.

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.

Gets box sign templates created by a user.

List the box skills metadata cards that are attached to a file.

Retrieves the files and/or folders contained within this collection.

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.

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 en

**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. assumi

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.

Retrieves a list of comments for a file.

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 onl

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 r

**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. as

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.

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.

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

Retrieves all of the groups for a given enterprise. the user must have admin permissions to inspect enterprise's groups.

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

Retrieves a list of items a legal hold policy has been assigned to.

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.

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

Retrieves all metadata for a given file.

Retrieves all metadata for a given folder. this can not be used on the root folder with id `0`.

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://g

Retrieves all pending collaboration invites for this user.

List previous file versions for legal hold policy assignment

Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.

Retrieves all of the retention policies for an enterprise.

Returns a list of all retention policy assignments associated with a specified retention policy.

Lists shield information barrier reports.

Lists shield information barrier segment members based on provided segment ids.

Lists shield information barrier segment restrictions based on provided segment id.

Retrieves a list of shield information barrier segment objects for the specified information barrier id.

Retrieves a list of shield information barrier objects for the enterprise of jwt.

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 endpo

Fetches all the storage policies in the enterprise.

Fetches all the storage policy assignment for an enterprise or user.

Lists all of the assignments for a given task.

Retrieves a list of all the tasks for a file. this endpoint does not support pagination.

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.

Retrieves an overview of users and their status for a terms of service, including whether they have accepted the terms and when.

Returns the current terms of service text and settings for the enterprise.

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

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

Retrieves all email aliases for a user. the collection does not include the primary login for the user.

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.

Returns a list of users who have been exempt from the collaboration domain restrictions.

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

Permanently deletes a file that is in the trash. this action cannot be undone.

Permanently deletes a folder that is in the trash. this action cannot be undone.

Permanently deletes a web link that is in the trash. this action cannot be undone.

Performs a check to verify that a file will be accepted by box before you upload the entire file.

Promote a specific version of a file. if previous versions exist, this method can be used to promote one of the older versions to the top of the version history. this creates a new copy of the old ver

Create a search using sql-like syntax to return items that match specific metadata. by default, this endpoint returns only the most basic info about the items for which the query matches. to get addit

Refresh an access token using its client id, secret, and refresh token.

Removes any box skills cards metadata from a file.

Removes any classifications from 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`

Removes any classifications from a folder. this api can also be called by including the enterprise id in the url explicitly, for example `/folders/:id/enterprise 12345/securityclassification-6vmvochwu

Deletes a single collaboration.

Permanently deletes a comment.

Deletes an individual device pin.

Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.

Removes an email alias from a user.

Move a file version to the trash. versions are only tracked for box users with premium accounts.

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

Delete an existing legal hold policy. this is an asynchronous process. the policy will not be fully deleted yet when the response returns.

Deletes a metadata cascade policy.

Deletes a piece of file metadata.

Deletes a piece of folder metadata.

Delete a metadata template and its instances. this deletion is permanent and can not be reversed.

Removes a retention policy assignment applied to content.

Removes a shared link from a file.

Removes a shared link from a folder.

Removes a shared link from a web link.

Removes a task from a file.

Abort an upload session and discard all data uploaded. this cannot be reversed. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload se

Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.

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

Removes the watermark from a file.

Removes the watermark from a folder.

Deletes a web link.

Deletes a webhook.

Request an access token using either a client-side obtained oauth 2.0 authorization code or a server-side jwt assertion. an access token is a string that enables box to verify that a request belongs t

Resends a signature request email to all outstanding signers.

Restores a file that has been moved to the trash. an optional new parent id can be provided to restore the file to in case the original folder has been deleted.

Restores a specific version of a file after it was deleted. don't use this endpoint to restore box notes, as it works with file formats such as pdf, doc, pptx or similar.

Restores a folder that has been moved to the trash. an optional new parent id can be provided to restore the folder to in case the original folder has been deleted. during this operation, part of the

Restores a web link that has been moved to the trash. an optional new parent id can be provided to restore the web link to in case the original folder has been deleted.

Get a list of files with current file versions for a legal hold assignment. in some cases you may want to get previous file versions instead. in these cases, use the `get /legal hold policy assignment

Revoke an active access token, effectively logging a user out that has been previously authenticated.

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

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

Transfers ownership of a specific folder (with id 0) from one user to another in the box cloud storage system. this endpoint should be used when you need to change the owner of a user's root folder, e

Remove a legal hold from an item. this is an asynchronous process. the policy will not be fully removed yet when the response returns.

Delete a storage policy assignment. deleting a storage policy assignment on a user will have the user inherit the enterprise's default storage policy. there is a rate limit for calling this endpoint o

Deletes a specific task assignment.

Updates an ai agent.

An alternative method that can be used to overwrite and update all box skill metadata cards on a file.

Updates a collaboration. can be used to change the owner of an item, or to accept collaboration invites.

Update the message of a comment.

Updates a file. this can be used to rename or move a file, create a shared link, or lock a file.

Updates a file request. this can be used to activate or deactivate a file request.

Updates a folder. this can be also be used to move the folder, create shared links, update collaborations, and more.

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

Updates a user's group membership. only admins of this group or users with admin-level permissions will be able to use this api.

Update legal hold policy.

Updates a retention policy.

Updates a shared link on a file.

Updates a shared link on a folder.

Updates a shared link on a web link.

Update shield information barrier segment with specified id

Updates a [slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-box-as-the-content-layer-for-slack). supports updating the box folder id and options. you need admin or co

Updates a specific storage policy assignment.

Updates a task. this can be used to update a task's configuration, or to update its completion state.

Updates a task assignment. this endpoint can be used to update the state of a task assigned to a user.

Updates a [teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-using-box-for-teams). supports updating the box folder id and options. you need admin or co-admin role to u

Updates a specific terms of service.

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

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

Updates a web link object.

Updates a webhook.

Uploads a small file to box. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this

Update a file's content. for file sizes over 50mb we recommend using the chunk upload apis. the `attributes` part of the body must come **before** the `file` part. requests that do not follow this for

Uploads a chunk of a file for an upload session. the actual endpoint url is returned by the [`create upload session`](e://post-files-upload-sessions) and [`get upload session`](e://get-files-upload-se