Box Platform API

OpenAPI apis-guru cloud

provides functionality to provide access to content stored within . It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.

Homepage: https://api.apis.guru/v2/specs/box.com/2.0.0.json
Provider: box.com
OpenAPI version: 3.0.2
Spec (JSON): https://api.apis.guru/v2/specs/box.com/2.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/box.com/2.0.0/openapi.yaml

Tools (262)

Extracted live via the executor SDK.

authorization.getAuthorize

Authorize a user by sending them through the 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.
authorization.postOauth2Revoke

Revoke an active Access Token, effectively logging a user out that has been previously authenticated.
authorization.postOauth2Token

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 to an authorized session. In the normal order of operations you will begin by requesting authentication from the endpoint and Box will send you an authorization code.
You will then send this code to this endpoint to exchange it for an Access Token. The returned Access Token can then be used to to make Box API calls.
authorization.postOauth2TokenRefresh

Refresh an Access Token using its client ID, secret, and refresh token.
boxSign.getSignRequests

Gets sign requests created by a user. If the sign_files and/or parent_folder are deleted, the sign request will not return in the list.
boxSign.getSignRequestsId

Gets a sign request by ID.
boxSign.postSignRequests

Creates a sign request. This involves preparing a document for signing and sending the sign request to signers.
boxSign.postSignRequestsIdCancel

Cancels a sign request.
boxSign.postSignRequestsIdResend

Resends a sign request email to all outstanding signers.
classifications.deleteMetadataTemplatesEnterpriseSecurityClassification6VmVochwUWoSchema

Delete all classifications by deleting the classification metadata template.
classifications.getMetadataTemplatesEnterpriseSecurityClassification6VmVochwUWoSchema

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.
classifications.postMetadataTemplatesSchemaClassifications

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.
classifications.putMetadataTemplatesEnterpriseSecurityClassification6VmVochwUWoSchemaAdd

Adds one or more new classifications to the list of classifications available to the 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.
classifications.putMetadataTemplatesEnterpriseSecurityClassification6VmVochwUWoSchemaDelete

Removes a classification from the list of classifications available to the 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.
classifications.putMetadataTemplatesEnterpriseSecurityClassification6VmVochwUWoSchemaUpdate

Updates the labels and descriptions of one or more classifications available to the 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.
classificationsOnFiles.deleteFilesIdMetadataEnterpriseSecurityClassification6VmVochwUWo

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.
classificationsOnFiles.getFilesIdMetadataEnterpriseSecurityClassification6VmVochwUWo

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.
classificationsOnFiles.postFilesIdMetadataEnterpriseSecurityClassification6VmVochwUWo

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.
classificationsOnFiles.putFilesIdMetadataEnterpriseSecurityClassification6VmVochwUWo

Updates a classification on a file.
The classification can only be updated if a classification has already been applied to the file before. When editing classifications, only values are defined for the enterprise will be accepted.
classificationsOnFolders.deleteFoldersIdMetadataEnterpriseSecurityClassification6VmVochwUWo

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-6VMVochwUWo.
classificationsOnFolders.getFoldersIdMetadataEnterpriseSecurityClassification6VmVochwUWo

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.
classificationsOnFolders.postFoldersIdMetadataEnterpriseSecurityClassification6VmVochwUWo

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.
classificationsOnFolders.putFoldersIdMetadataEnterpriseSecurityClassification6VmVochwUWo

Updates a classification on a folder.
The classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted.
collaborations.deleteCollaborationsId

Deletes a single collaboration.
collaborations.getCollaborationsId

Retrieves a single collaboration.
collaborations.postCollaborations

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.
collaborations.putCollaborationsId

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

Retrieves all pending collaboration invites for this user.
collaborationsList.getFilesIdCollaborations

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.
collaborationsList.getFoldersIdCollaborations

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.
collaborationsList.getGroupsIdCollaborations

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.
collections.getCollections

Retrieves all collections for a given user.
Currently, only the favorites collection is supported.
collections.getCollectionsIdItems

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

Permanently deletes a comment.
comments.getCommentsId

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

Retrieves a list of comments for a file.
comments.postComments

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

Update the message of a comment.
devicePinners.deleteDevicePinnersId

Deletes an individual device pin.
devicePinners.getDevicePinnersId

Retrieves information about an individual device pin.
devicePinners.getEnterprisesIdDevicePinners

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.
domainRestrictionsForCollaborations.deleteCollaborationWhitelistEntriesId

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

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

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

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

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

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

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

Exempts a user from the restrictions set out by the allowed list of domains for collaborations.
downloads.getFilesIdContent

Returns the contents of a file in binary format.
emailAliases.deleteUsersIdEmailAliasesId

Removes an email alias from a user.
emailAliases.getUsersIdEmailAliases

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

Adds a new email alias to a user account..
events.getEvents

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.
events.optionsEvents

Returns a list of real-time servers that can be used for long-polling updates to the .
Long polling is the concept where a HTTP request is kept open until the server sends a response, then repeating the process over and over to receive updated responses.
Long polling the event stream can only be used for user events, not for enterprise events.
To use long polling, first use this endpoint to retrieve a list of long poll URLs. Next, make a long poll request to any of the provided URLs.
When an event occurs in monitored account a response with the value new_change will be sent. The response contains no other details as it only serves as a prompt to take further action such as sending a request to the with the last known stream_position.
After the server sends this response it closes the connection. You must now repeat the long poll process to begin listening for events again.
If no events occur for a while and the connection times out you will receive a response with the value reconnect. When you receive this response you’ll make another call to this endpoint to restart the process.
If you receive no events in retry_timeout seconds then you will need to make another request to the real-time server (one of the URLs in the response for this endpoint). This might be necessary due to network errors.
Finally, if you receive a max_retries error when making a request to the real-time server, you should start over by making a call to this endpoint first.
fileRequests.deleteFileRequestsId

Deletes a file request permanently.
fileRequests.getFileRequestsId

Retrieves the information about a file request.
fileRequests.postFileRequestsIdCopy

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

Updates a file request. This can be used to activate or deactivate a file request.
files.deleteFilesId

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.
files.getFilesId

Retrieves the details about a file.
files.getFilesIdThumbnailId

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].
files.optionsFilesContent

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

Creates a copy of a file.
files.putFilesId

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

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.
fileVersionLegalHolds.getFileVersionLegalHoldsId

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

Retrieves all file version retentions for the given enterprise.
fileVersionRetentions.getFileVersionRetentionsId

Returns information about a file version retention.
fileVersions.deleteFilesIdVersionsId

Move a file version to the trash.
Versions are only tracked for Box users with premium accounts.
fileVersions.getFilesIdVersions

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.
fileVersions.getFilesIdVersionsId

Retrieve a specific version of a file.
Versions are only tracked for Box users with premium accounts.
fileVersions.postFilesIdVersionsCurrent

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 version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the the same hash digest, etag, and name as the original.
Other properties such as comments do not get updated to their former values.
Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.
fileVersions.putFilesIdVersionsId

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.
folderLocks.deleteFolderLocksId

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.
folderLocks.getFolderLocks

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.
folderLocks.postFolderLocks

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.
folders.deleteFoldersId

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

Retrieves details for a folder, including the first 100 entries in the folder.
To fetch more items within the folder, please use the endpoint.
folders.getFoldersIdItems

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, please use the endpoint instead.
folders.postFolders

Creates a new empty folder within the specified parent folder.
folders.postFoldersIdCopy

Creates a copy of a folder within a destination folder.
The original folder will not be changed.
folders.putFoldersId

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

Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
groupMemberships.getGroupMembershipsId

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
groupMemberships.getGroupsIdMemberships

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.
groupMemberships.getUsersIdMemberships

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.
groupMemberships.postGroupMemberships

Creates a group membership. Only users with admin-level permissions will be able to use this API.
groupMemberships.putGroupMembershipsId

Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
groups.deleteGroupsId

Permanently deletes a group. Only users with admin-level permissions will be able to use this API.
groups.getGroups

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

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.
groups.postGroups

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

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.
groups.putGroupsId

Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.
invites.getInvitesId

Returns the status of a user invite.
invites.postInvites

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.
legalHoldPolicies.deleteLegalHoldPoliciesId

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

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

Retrieve a legal hold policy.
legalHoldPolicies.postLegalHoldPolicies

Create a new legal hold policy.
legalHoldPolicies.putLegalHoldPoliciesId

Update legal hold policy.
legalHoldPolicyAssignments.deleteLegalHoldPolicyAssignmentsId

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

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

Retrieve a legal hold policy assignment.
legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentsIdFilesOnHold

Get a list of 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_assignments/:id/file_versions_on_hold API instead to return any previous versions of a file for this legal hold policy assignment.
Due to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The GET /file_version_legal_holds API can be used to fetch current and past versions of files held within the legacy architecture.
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.
legalHoldPolicyAssignments.getLegalHoldPolicyAssignmentsIdFileVersionsOnHold

Get a list of previous file versions for a legal hold assignment.
In some cases you may only need the latest file versions instead. In these cases, use the GET /legal_hold_policy_assignments/:id/files_on_hold API instead to return any current (latest) versions of a file for this legal hold policy assignment.
Due to ongoing re-architecture efforts this API might not return all files held for this policy ID. Instead, this API will only return past file versions held in the newly developed architecture. The GET /file_version_legal_holds API can be used to fetch current and past versions of files held within the legacy architecture.
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.
legalHoldPolicyAssignments.postLegalHoldPolicyAssignments

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

Deletes a metadata cascade policy.
metadataCascadePolicies.getMetadataCascadePolicies

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.
metadataCascadePolicies.getMetadataCascadePoliciesId

Retrieve a specific metadata cascade policy assigned to a folder.
metadataCascadePolicies.postMetadataCascadePolicies

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.
metadataCascadePolicies.postMetadataCascadePoliciesIdApply

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.
metadataInstancesFiles.deleteFilesIdMetadataIdId

Deletes a piece of file metadata.
metadataInstancesFiles.getFilesIdMetadata

Retrieves all metadata for a given file.
metadataInstancesFiles.getFilesIdMetadataIdId

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

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.
metadataInstancesFiles.putFilesIdMetadataIdId

Updates a piece of metadata on a file.
The metadata instance can only be updated if the template has already been applied to the file before. When editing metadata, only values that match the metadata template schema will be accepted.
The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.
metadataInstancesFolders.deleteFoldersIdMetadataIdId

Deletes a piece of folder metadata.
metadataInstancesFolders.getFoldersIdMetadata

Retrieves all metadata for a given folder. This can not be used on the root folder with ID 0.
metadataInstancesFolders.getFoldersIdMetadataIdId

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.
metadataInstancesFolders.postFoldersIdMetadataIdId

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.
metadataInstancesFolders.putFoldersIdMetadataIdId

Updates a piece of metadata on a folder.
The metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted.
The update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.
metadataTemplates.deleteMetadataTemplatesIdIdSchema

Delete a metadata template and its instances. This deletion is permanent and can not be reversed.
metadataTemplates.getMetadataTemplates

Finds a metadata template by searching for the ID of an instance of the template.
metadataTemplates.getMetadataTemplatesEnterprise

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

Used to retrieve all generic, global metadata templates available to all enterprises using Box.
metadataTemplates.getMetadataTemplatesId

Retrieves a metadata template by its ID.
metadataTemplates.getMetadataTemplatesIdIdSchema

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.
metadataTemplates.postMetadataTemplatesSchema

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

Updates a metadata template.
The metadata template can only be updated if the template already exists.
The update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.
recentItems.getRecentItems

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

Permanently deletes a retention policy.
retentionPolicies.getRetentionPolicies

Retrieves all of the retention policies for an enterprise.
retentionPolicies.getRetentionPoliciesId

Retrieves a retention policy.
retentionPolicies.postRetentionPolicies

Creates a retention policy.
retentionPolicies.putRetentionPoliciesId

Updates a retention policy.
retentionPolicyAssignments.deleteRetentionPolicyAssignmentsId

Removes a retention policy assignment applied to content.
retentionPolicyAssignments.getRetentionPoliciesIdAssignments

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

Retrieves a retention policy assignment
retentionPolicyAssignments.getRetentionPolicyAssignmentsIdFilesUnderRetention

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

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

Assigns a retention policy to an item.
search.getMetadataQueryIndices

Retrieves the metadata query indices for a given scope and template key.
search.getSearch

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

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 additional fields for each item, including any of the metadata, use the fields attribute in the query.
sharedLinksFiles.getFilesIdGetSharedLink

Gets the information for a shared link on a file.
sharedLinksFiles.getSharedItems

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.
sharedLinksFiles.putFilesIdAddSharedLink

Adds a shared link to a file.
sharedLinksFiles.putFilesIdRemoveSharedLink

Removes a shared link from a file.
sharedLinksFiles.putFilesIdUpdateSharedLink

Updates a shared link on a file.
sharedLinksFolders.getFoldersIdGetSharedLink

Gets the information for a shared link on a folder.
sharedLinksFolders.getSharedItemsFolders

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.
sharedLinksFolders.putFoldersIdAddSharedLink

Adds a shared link to a folder.
sharedLinksFolders.putFoldersIdRemoveSharedLink

Removes a shared link from a folder.
sharedLinksFolders.putFoldersIdUpdateSharedLink

Updates a shared link on a folder.
sharedLinksWebLinks.getSharedItemsWebLinks

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.
sharedLinksWebLinks.getWebLinksIdGetSharedLink

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

Adds a shared link to a web link.
sharedLinksWebLinks.putWebLinksIdRemoveSharedLink

Removes a shared link from a web link.
sharedLinksWebLinks.putWebLinksIdUpdateSharedLink

Updates a shared link on a web link.
shieldInformationBarrierReports.getShieldInformationBarrierReports

Lists shield information barrier reports with specific IDs.
shieldInformationBarrierReports.getShieldInformationBarrierReportsId

Retrieves a shield information barrier report by its ID.
shieldInformationBarrierReports.postShieldInformationBarrierReports

Creates a shield information barrier report for a given barrier.
shieldInformationBarriers.getShieldInformationBarriers

Retrieves a list of shield information barrier objects for the enterprise of JWT.
shieldInformationBarriers.getShieldInformationBarriersId

Get shield information barrier based on provided ID..
shieldInformationBarriers.postShieldInformationBarriers

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

Change status of shield information barrier with the specified ID.
shieldInformationBarrierSegmentMembers.deleteShieldInformationBarrierSegmentMembersId

Deletes a shield information barrier segment member based on provided ID.
shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers

Lists shield information barrier segment members based on provided segment IDs.
shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembersId

Retrieves a shield information barrier segment member by its ID.
shieldInformationBarrierSegmentMembers.postShieldInformationBarrierSegmentMembers

Creates a new shield information barrier segment member.
shieldInformationBarrierSegmentRestrictions.deleteShieldInformationBarrierSegmentRestrictionsId

Delete shield information barrier segment restriction based on provided ID.
shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictions

Lists shield information barrier segment restrictions based on provided segment ID.
shieldInformationBarrierSegmentRestrictions.getShieldInformationBarrierSegmentRestrictionsId

Retrieves a shield information barrier segment restriction based on provided ID.
shieldInformationBarrierSegmentRestrictions.postShieldInformationBarrierSegmentRestrictions

Creates a shield information barrier segment restriction object.
shieldInformationBarrierSegments.deleteShieldInformationBarrierSegmentsId

Deletes the shield information barrier segment based on provided ID.
shieldInformationBarrierSegments.getShieldInformationBarrierSegments

Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.
shieldInformationBarrierSegments.getShieldInformationBarrierSegmentsId

Retrieves shield information barrier segment based on provided ID..
shieldInformationBarrierSegments.postShieldInformationBarrierSegments

Creates a shield information barrier segment.
shieldInformationBarrierSegments.putShieldInformationBarrierSegmentsId

Updates the shield information barrier segment based on provided ID..
skills.deleteFilesIdMetadataGlobalBoxSkillsCards

Removes any Box Skills cards metadata from a file.
skills.getFilesIdMetadataGlobalBoxSkillsCards

List the Box Skills metadata cards that are attached to a file.
skills.postFilesIdMetadataGlobalBoxSkillsCards

Applies one or more Box Skills metadata cards to a file.
skills.putFilesIdMetadataGlobalBoxSkillsCards

Updates one or more Box Skills metadata cards to a file.
skills.putSkillInvocationsId

An alternative method that can be used to overwrite and update all Box Skill metadata cards on a file.
storagePolicies.getStoragePolicies

Fetches all the storage policies in the enterprise.
storagePolicies.getStoragePoliciesId

Fetches a specific storage policy.
storagePolicyAssignments.deleteStoragePolicyAssignmentsId

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 of only twice per user in a 24 hour time frame.
storagePolicyAssignments.getStoragePolicyAssignments

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

Fetches a specific storage policy assignment.
storagePolicyAssignments.postStoragePolicyAssignments

Creates a storage policy assignment for an enterprise or user.
storagePolicyAssignments.putStoragePolicyAssignmentsId

Updates a specific storage policy assignment.
taskAssignments.deleteTaskAssignmentsId

Deletes a specific task assignment.
taskAssignments.getTaskAssignmentsId

Retrieves information about a task assignment.
taskAssignments.getTasksIdAssignments

Lists all of the assignments for a given task.
taskAssignments.postTaskAssignments

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

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

Removes a task from a file.
tasks.getFilesIdTasks

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

Retrieves information about a specific task.
tasks.postTasks

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

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

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

Fetches a specific terms of service.
termsOfService.postTermsOfServices

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

Updates a specific terms of service.
termsOfServiceUserStatuses.getTermsOfServiceUserStatuses

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

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

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

Move all of the items (files, folders and workflows) owned by a user into another user's account
Only the root folder (0) can be transferred.
Folders can only be moved across users by users with administrative permissions.
All existing shared links and folder-level collaborations are transferred during the operation. Please note that while collaborations at the individual file-level are transferred during the operation, the collaborations are deleted when the original user is deleted.
This call will be performed synchronously which might lead to a slow response when the source user has a large number of items in all of its folders.
If the destination path has a metadata cascade policy attached to any of the parent folders, a metadata cascade operation will be kicked off asynchronously.
There is currently no way to check for when this operation is finished.
The destination folder's name will be in the format {User}'s Files and Folders, where {User} is the display name of the user.
To make this API call your application will need to have the "Read and write all files and folders stored in Box" scope enabled.
Please make sure the destination user has access to Relay or Relay Lite, and has access to the files and folders involved in the workflows being transferred.
Admins will receive an email when the operation is completed.
trashedFiles.deleteFilesIdTrash

Permanently deletes a file that is in the trash. This action cannot be undone.
trashedFiles.getFilesIdTrash

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 [blocked] API.
To list all items that have been moved to the trash, please use the GET /folders/trash/items [blocked] API.
trashedFiles.postFilesId

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.
trashedFolders.deleteFoldersIdTrash

Permanently deletes a folder that is in the trash. This action cannot be undone.
trashedFolders.getFoldersIdTrash

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 [blocked] API.
To list all items that have been moved to the trash, please use the GET /folders/trash/items [blocked] API.
trashedFolders.postFoldersId

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.
Folder locking
During this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.
For the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.
trashedItems.getFoldersTrashItems

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.
trashedWebLinks.deleteWebLinksIdTrash

Permanently deletes a web link that is in the trash. This action cannot be undone.
trashedWebLinks.getWebLinksIdTrash

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

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.
uploads.postFilesContent

Uploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs.
Request body order
The attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive a HTTP 400 error with a metadata_after_file_contents error code.
uploads.postFilesIdContent

Update a file's content. For file sizes over 50MB we recommend using the Chunk Upload APIs.
Request body order
The attributes part of the body must come before the file part. Requests that do not follow this format when uploading the file will receive a HTTP 400 error with a metadata_after_file_contents error code.
uploadsChunked.deleteFilesUploadSessionsId

Abort an upload session and discard all data uploaded.
This cannot be reversed.
uploadsChunked.getFilesUploadSessionsId

Return information about an upload session.
uploadsChunked.getFilesUploadSessionsIdParts

Return a list of the chunks uploaded to the upload session so far.
uploadsChunked.postFilesIdUploadSessions

Creates an upload session for an existing file.
uploadsChunked.postFilesUploadSessions

Creates an upload session for a new file.
uploadsChunked.postFilesUploadSessionsIdCommit

Close an upload session and create a file from the uploaded chunks.
uploadsChunked.putFilesUploadSessionsId

Updates a chunk of an upload session for a file.
userAvatars.deleteUsersIdAvatar

Removes an existing user avatar. You cannot reverse this operation.
userAvatars.getUsersIdAvatar

Retrieves an image of a the user's avatar.
userAvatars.postUsersIdAvatar

Adds or updates a user avatar.
users.deleteUsersId

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.
users.getUsers

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.
users.getUsersId

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.
users.getUsersMe

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.
users.postUsers

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

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.
users.putUsersId

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

Removes the watermark from a file.
watermarksFiles.getFilesIdWatermark

Retrieve the watermark for a file.
watermarksFiles.putFilesIdWatermark

Applies or update a watermark on a file.
watermarksFolders.deleteFoldersIdWatermark

Removes the watermark from a folder.
watermarksFolders.getFoldersIdWatermark

Retrieve the watermark for a folder.
watermarksFolders.putFoldersIdWatermark

Applies or update a watermark on a folder.
webhooks.deleteWebhooksId

Deletes a webhook.
webhooks.getWebhooks

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.
webhooks.getWebhooksId

Retrieves a specific webhook
webhooks.postWebhooks

Creates a webhook.
webhooks.putWebhooksId

Updates a webhook.
webLinks.deleteWebLinksId

Deletes a web link.
webLinks.getWebLinksId

Retrieve information about a web link.
webLinks.postWebLinks

Creates a web link object within a folder.
webLinks.putWebLinksId

Updates a web link object.
workflows.getWorkflows

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.
workflows.postWorkflowsIdStart

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.
zipDownloads.getZipDownloadsIdContent

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 [blocked] API to request to create a zip archive, and then follow the download_url field in the response to this endpoint.
zipDownloads.getZipDownloadsIdStatus

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 [blocked] API to request to create a zip archive, and then follow the status_url field in the response to this endpoint.
zipDownloads.postZipDownloads

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
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools

Tools (262)

Folder locking

Request body order

Request body order