Box

Box Platform API

[Box Platform](https://developer.box.com) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for…

Data & analytics#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Box Platform provides functionality to provide access to content stored within Box. 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.

Endpoints 297

AI

  • POSTAsk question/ai/askSends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context. You can ask a question…
  • POSTGenerate text/ai/text_genSends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.
  • GETGet AI agent default configuration/ai_agent_default?mode=ask&language=ja&model=azure__openai__gpt_4o_miniGet the AI agent default config.
  • POSTExtract metadata (freeform)/ai/extractSends 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…
  • POSTExtract metadata (structured)/ai/extract_structuredSends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs. To define the extraction structure,…

AI Studio

  • GETList AI agents/ai_agents?mode=ask,text_gen,extract&fields=ask,text_gen,extract&agent_state=enabled&include_box_default=true&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Lists AI agents based on the provided parameters.
  • POSTCreate AI agent/ai_agentsCreates an AI agent. At least one of the following capabilities must be provided: ask, text_gen, extract.
  • GETGet AI agent by agent ID/ai_agents/:agent_id?fields=ask,text_gen,extractGets an AI Agent using the agent_id parameter.
  • PUTUpdate AI agent/ai_agents/:agent_idUpdates an AI agent.
  • DELETEDelete AI agent/ai_agents/:agent_idDeletes an AI agent using the provided parameters.

App item associations

  • GETList file app item associations/files/:file_id/app_item_associations?limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&application_type=hubsThis 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…
  • GETList folder app item associations/folders/:folder_id/app_item_associations?limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&application_type=hubsThis 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…

Authorization

  • GETAuthorize userhttps://account.box.com/api/oauth2/authorize?response_type=code&client_id=ly1nj6n11vionaie65emwzk575hnnmrk&redirect_uri=http://example.com/auth/callback&state=my_state&scope=admin_readwriteAuthorize a user by sending them through the Box website and request their permission to act on their behalf. This is the first step when authenticating a…
  • POSTRequest access tokenhttps://api.box.com/oauth2/tokenRequest 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…
  • POSTRefresh access tokenhttps://api.box.com/oauth2/token#refreshRefresh an Access Token using its client ID, secret, and refresh token.
  • POSTRevoke access tokenhttps://api.box.com/oauth2/revokeRevoke an active Access Token, effectively logging a user out that has been previously authenticated.

Box Sign requests

  • POSTCancel Box Sign request/sign_requests/:sign_request_id/cancelCancels a sign request.
  • POSTResend Box Sign request/sign_requests/:sign_request_id/resendResends a signature request email to all outstanding signers.
  • GETGet Box Sign request by ID/sign_requests/:sign_request_idGets a sign request by ID.
  • GETList Box Sign requests/sign_requests?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000&senders=sender1@boxdemo.com,sender2@boxdemo.com&shared_requests=trueGets 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.
  • POSTCreate Box Sign request/sign_requestsCreates a signature request. This involves preparing a document for signing and sending the signature request to signers.

Box Sign templates

  • GETList Box Sign templates/sign_templates?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Gets Box Sign templates created by a user.
  • GETGet Box Sign template by ID/sign_templates/:template_idFetches details of a specific Box Sign template.

Classifications

  • GETList all classifications/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schemaRetrieves the classification metadata template and lists all the classifications available to this enterprise. This API can also be called by including the…
  • PUTAdd classification/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#addAdds 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…
  • PUTUpdate classification/metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#updateUpdates 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…
  • POSTAdd initial classifications/metadata_templates/schema#classificationsWhen an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. If an…

Classifications on files

  • GETGet classification on file/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWoRetrieves 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…
  • PUTUpdate classification on file/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWoUpdates a classification on a file. The classification can only be updated if a classification has already been applied to the file before. When editing…
  • POSTAdd classification to file/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWoAdds 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…
  • DELETERemove classification from file/files/:file_id/metadata/enterprise/securityClassification-6VMVochwUWoRemoves any classifications from a file. This API can also be called by including the enterprise ID in the URL explicitly, for example…

Classifications on folders

  • GETGet classification on folder/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWoRetrieves 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…
  • PUTUpdate classification on folder/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWoUpdates a classification on a folder. The classification can only be updated if a classification has already been applied to the folder before. When editing…
  • POSTAdd classification to folder/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWoAdds 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…
  • DELETERemove classification from folder/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWoRemoves any classifications from a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example…

Collaborations

  • GETGet collaboration/collaborations/:collaboration_id?fields=id,type,nameRetrieves a single collaboration.
  • PUTUpdate collaboration/collaborations/:collaboration_idUpdates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is…
  • DELETERemove collaboration/collaborations/:collaboration_idDeletes a single collaboration.
  • POSTCreate collaboration/collaborations?fields=id,type,name&notify=trueAdds 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…

Collaborations (List)

  • GETList file collaborations/files/:file_id/collaborations?fields=id,type,name&limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiRetrieves 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.
  • GETList folder collaborations/folders/:folder_id/collaborations?fields=id,type,name&limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiRetrieves 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…
  • GETList pending collaborations/collaborations?status=pending&fields=id,type,name&offset=1000&limit=1000Retrieves all pending collaboration invites for this user.
  • GETList group collaborations/groups/:group_id/collaborations?limit=1000&offset=1000Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. Each collaboration object has details on…

Collections

  • GETList all collections/collections?fields=id,type,name&offset=1000&limit=1000Retrieves all collections for a given user. Currently, only the favorites collection is supported.
  • GETList collection items/collections/:collection_id/items?fields=id,type,name&offset=1000&limit=1000Retrieves the files and/or folders contained within this collection.
  • GETGet collection by ID/collections/:collection_idRetrieves a collection by its ID.

Comments

  • GETList file comments/files/:file_id/comments?fields=id,type,name&limit=1000&offset=1000Retrieves a list of comments for a file.
  • GETGet comment/comments/:comment_id?fields=id,type,nameRetrieves the message and metadata for a specific comment, as well as information on the user who created the comment.
  • PUTUpdate comment/comments/:comment_id?fields=id,type,nameUpdate the message of a comment.
  • DELETERemove comment/comments/:comment_idPermanently deletes a comment.
  • POSTCreate comment/comments?fields=id,type,nameAdds a comment by the user to a specific file, or as a reply to an other comment.

Device pinners

  • GETGet device pin/device_pinners/:device_pinner_idRetrieves information about an individual device pin.
  • DELETERemove device pin/device_pinners/:device_pinner_idDeletes an individual device pin.
  • GETList enterprise device pins/enterprises/:enterprise_id/device_pinners?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000&direction=ASCRetrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this…

Domain restrictions (User exemptions)

  • GETList users exempt from collaboration domain restrictions/collaboration_whitelist_exempt_targets?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Returns a list of users who have been exempt from the collaboration domain restrictions.
  • POSTCreate user exemption from collaboration domain restrictions/collaboration_whitelist_exempt_targetsExempts a user from the restrictions set out by the allowed list of domains for collaborations.
  • GETGet user exempt from collaboration domain restrictions/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_idReturns a users who has been exempt from the collaboration domain restrictions.
  • DELETERemove user from list of users exempt from domain restrictions/collaboration_whitelist_exempt_targets/:collaboration_whitelist_exempt_target_idRemoves a user's exemption from the restrictions set out by the allowed list of domains for collaborations.

Domain restrictions for collaborations

  • GETList allowed collaboration domains/collaboration_whitelist_entries?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.
  • POSTAdd domain to list of allowed collaboration domains/collaboration_whitelist_entriesCreates a new entry in the list of allowed domains to allow collaboration for.
  • GETGet allowed collaboration domain/collaboration_whitelist_entries/:collaboration_whitelist_entry_idReturns a domain that has been deemed safe to create collaborations for within the current enterprise.
  • DELETERemove domain from list of allowed collaboration domains/collaboration_whitelist_entries/:collaboration_whitelist_entry_idRemoves a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.

Downloads

  • GETDownload file/files/:file_id/content?version=4&access_token=c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQReturns the contents of a file in binary format.

Email aliases

  • GETList user's email aliases/users/:user_id/email_aliasesRetrieves all email aliases for a user. The collection does not include the primary login for the user.
  • POSTCreate email alias/users/:user_id/email_aliasesAdds a new email alias to a user account..
  • DELETERemove email alias/users/:user_id/email_aliases/:email_alias_idRemoves an email alias from a user.

Events

  • GETList user and enterprise events/events?stream_type=all&stream_position=1348790499819&limit=50&event_type=ACCESS_GRANTED&created_after=2012-12-12T10:53:43-08:00&created_before=2013-12-12T10:53:43-08:00Returns 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…
  • OPTIONSGet events long poll endpoint/eventsReturns a list of real-time servers that can be used for long-polling updates to the event stream. Long polling is the concept where a HTTP request is kept…

File requests

  • GETGet file request/file_requests/:file_request_idRetrieves the information about a file request.
  • PUTUpdate file request/file_requests/:file_request_idUpdates a file request. This can be used to activate or deactivate a file request.
  • DELETEDelete file request/file_requests/:file_request_idDeletes a file request permanently.
  • POSTCopy file request/file_requests/:file_request_id/copyCopies an existing file request that is already present on one folder, and applies it to another folder.

File version legal holds

  • GETGet file version legal hold/file_version_legal_holds/:file_version_legal_hold_idRetrieves information about the legal hold policies assigned to a file version.
  • GETList file version legal holds/file_version_legal_holds?policy_id=133870&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Get 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…

File version retentions

  • GETList file version retentions/file_version_retentions?file_id=43123123&file_version_id=1&policy_id=982312&disposition_action=permanently_delete&disposition_before=2012-12-12T10:53:43-08:00&disposition_after=2012-12-19T10:34:23-08:00&limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiRetrieves all file version retentions for the given enterprise. Note: File retention API is now deprecated. To get information about files and file versions…
  • GETGet retention on file/file_version_retentions/:file_version_retention_idReturns information about a file version retention. Note: File retention API is now deprecated. To get information about files and file versions under…

File versions

  • GETList all file versions/files/:file_id/versions?fields=id,type,name&limit=1000&offset=1000Retrieve 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…
  • GETGet file version/files/:file_id/versions/:file_version_id?fields=id,type,nameRetrieve a specific version of a file. Versions are only tracked for Box users with premium accounts.
  • PUTRestore file version/files/:file_id/versions/:file_version_idRestores 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…
  • DELETERemove file version/files/:file_id/versions/:file_version_idMove a file version to the trash. Versions are only tracked for Box users with premium accounts.
  • POSTPromote file version/files/:file_id/versions/current?fields=id,type,namePromote 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…

Files

  • GETGet file information/files/:file_id?fields=id,type,nameRetrieves the details about a file.
  • PUTUpdate file/files/:file_id?fields=id,type,nameUpdates a file. This can be used to rename or move a file, create a shared link, or lock a file.
  • DELETEDelete file/files/:file_idDeletes a file, either permanently or by moving it to the trash. The enterprise settings determine whether the item will be permanently deleted from Box or…
  • OPTIONSPreflight check before upload/files/contentPerforms a check to verify that a file will be accepted by Box before you upload the entire file.
  • POSTCopy file/files/:file_id/copy?fields=id,type,nameCreates a copy of a file.
  • GETGet file thumbnail/files/:file_id/thumbnail.:extension?min_height=32&min_width=32&max_height=320&max_width=320Retrieves 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…

Folder Locks

  • GETList folder locks/folder_locks?folder_id=12345Retrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.
  • POSTCreate folder lock/folder_locksCreates 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…
  • DELETEDelete folder lock/folder_locks/:folder_lock_idDeletes a folder lock on a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

Folders

  • GETGet folder information/folders/:folder_id?fields=id,type,name&sort=id&direction=ASC&offset=1000&limit=1000Retrieves details for a folder, including the first 100 entries in the folder. Passing sort, direction, offset, and limit parameters in query allows you to…
  • PUTUpdate folder/folders/:folder_id?fields=id,type,nameUpdates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.
  • DELETEDelete folder/folders/:folder_id?recursive=trueDeletes a folder, either permanently or by moving it to the trash.
  • GETList items in folder/folders/:folder_id/items?fields=id,type,name&usemarker=true&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&offset=1000&limit=1000&sort=id&direction=ASCRetrieves 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,…
  • POSTCreate folder/folders?fields=id,type,nameCreates a new empty folder within the specified parent folder.
  • POSTCopy folder/folders/:folder_id/copy?fields=id,type,nameCreates a copy of a folder within a destination folder. The original folder will not be changed.

Group memberships

  • GETList user's groups/users/:user_id/memberships?limit=1000&offset=1000Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.
  • GETList members of group/groups/:group_id/memberships?limit=1000&offset=1000Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.
  • POSTAdd user to group/group_memberships?fields=id,type,nameCreates a group membership. Only users with admin-level permissions will be able to use this API.
  • GETGet group membership/group_memberships/:group_membership_id?fields=id,type,nameRetrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
  • PUTUpdate group membership/group_memberships/:group_membership_id?fields=id,type,nameUpdates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.
  • DELETERemove user from group/group_memberships/:group_membership_idDeletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

Groups

  • GETList groups for enterprise/groups?filter_term=Engineering&fields=id,type,name&limit=1000&offset=1000Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.
  • POSTCreate group/groups?fields=id,type,nameCreates a new group of users in an enterprise. Only users with admin permissions can create new groups.
  • GETGet group/groups/:group_id?fields=id,type,nameRetrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.
  • PUTUpdate group/groups/:group_id?fields=id,type,nameUpdates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.
  • DELETERemove group/groups/:group_idPermanently deletes a group. Only users with admin-level permissions will be able to use this API.

Integration mappings

  • GETList Slack integration mappings/integration_mappings/slack?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000&partner_item_type=channel&partner_item_id=12345&box_item_id=12345&box_item_type=folder&is_manually_created=trueLists Slack integration mappings in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
  • POSTCreate Slack integration mapping/integration_mappings/slackCreates a Slack integration mapping by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
  • PUTUpdate Slack integration mapping/integration_mappings/slack/:integration_mapping_idUpdates a Slack integration mapping. Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.
  • DELETEDelete Slack integration mapping/integration_mappings/slack/:integration_mapping_idDeletes a Slack integration mapping. You need Admin or Co-Admin role to use this endpoint.
  • GETList Teams integration mappings/integration_mappings/teams?partner_item_type=channel&partner_item_id=12345&box_item_id=12345&box_item_type=folderLists Teams integration mappings in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.
  • POSTCreate Teams integration mapping/integration_mappings/teamsCreates a Teams integration mapping by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.
  • PUTUpdate Teams integration mapping/integration_mappings/teams/:integration_mapping_idUpdates a Teams integration mapping. Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.
  • DELETEDelete Teams integration mapping/integration_mappings/teams/:integration_mapping_idDeletes a Teams integration mapping. You need Admin or Co-Admin role to use this endpoint.

Invites

  • POSTCreate user invite/invites?fields=id,type,nameInvites an existing external user to join an enterprise. The user must already have a Box account and cannot be part of another enterprise. Once invited, the…
  • GETGet user invite status/invites/:invite_id?fields=id,type,nameReturns the status of a user invite.

Legal hold policies

  • GETList all legal hold policies/legal_hold_policies?policy_name=Sales Policy&fields=id,type,name&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Retrieves a list of legal hold policies that belong to an enterprise.
  • POSTCreate legal hold policy/legal_hold_policiesCreate a new legal hold policy.
  • GETGet legal hold policy/legal_hold_policies/:legal_hold_policy_idRetrieve a legal hold policy.
  • PUTUpdate legal hold policy/legal_hold_policies/:legal_hold_policy_idUpdate legal hold policy.
  • DELETERemove legal hold policy/legal_hold_policies/:legal_hold_policy_idDelete an existing legal hold policy. This is an asynchronous process. The policy will not be fully deleted yet when the response returns.

Legal hold policy assignments

  • GETList legal hold policy assignments/legal_hold_policy_assignments?policy_id=324432&assign_to_type=file&assign_to_id=1234323&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000&fields=id,type,nameRetrieves a list of items a legal hold policy has been assigned to.
  • POSTAssign legal hold policy/legal_hold_policy_assignmentsAssign a legal hold to an item type of: file, file version, folder, user, ownership, interactions, or metadata template.
  • GETGet legal hold policy assignment/legal_hold_policy_assignments/:legal_hold_policy_assignment_idRetrieve a legal hold policy assignment.
  • DELETEUnassign legal hold policy/legal_hold_policy_assignments/:legal_hold_policy_assignment_idRemove a legal hold from an item. This is an asynchronous process. The policy will not be fully removed yet when the response returns.
  • GETList files with current file versions for legal hold policy assignment/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/files_on_hold?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000&fields=id,type,nameGet 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,…
  • GETList previous file versions for legal hold policy assignment/legal_hold_policy_assignments/:legal_hold_policy_assignment_id/file_versions_on_hold?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000&fields=id,type,nameGet 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…

Metadata cascade policies

  • GETList metadata cascade policies/metadata_cascade_policies?folder_id=31232&owner_enterprise_id=31232&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&offset=1000Retrieves 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.
  • POSTCreate metadata cascade policy/metadata_cascade_policiesCreates 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…
  • GETGet metadata cascade policy/metadata_cascade_policies/:metadata_cascade_policy_idRetrieve a specific metadata cascade policy assigned to a folder.
  • DELETERemove metadata cascade policy/metadata_cascade_policies/:metadata_cascade_policy_idDeletes a metadata cascade policy.
  • POSTForce-apply metadata cascade policy to folder/metadata_cascade_policies/:metadata_cascade_policy_id/applyForce 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…

Metadata instances (Files)

  • GETList metadata instances on file/files/:file_id/metadata?view=hydratedRetrieves all metadata for a given file.
  • GETGet metadata instance on file/files/:file_id/metadata/:scope/:template_key?view=hydratedRetrieves the instance of a metadata template that has been applied to a file.
  • PUTUpdate metadata instance on file/files/:file_id/metadata/:scope/:template_keyUpdates 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…
  • POSTCreate metadata instance on file/files/:file_id/metadata/:scope/:template_keyApplies 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…
  • DELETERemove metadata instance from file/files/:file_id/metadata/:scope/:template_keyDeletes a piece of file metadata.

Metadata instances (Folders)

  • GETList metadata instances on folder/folders/:folder_id/metadata?view=hydratedRetrieves all metadata for a given folder. This can not be used on the root folder with ID 0.
  • GETGet metadata instance on folder/folders/:folder_id/metadata/:scope/:template_keyRetrieves 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.
  • PUTUpdate metadata instance on folder/folders/:folder_id/metadata/:scope/:template_keyUpdates 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…
  • POSTCreate metadata instance on folder/folders/:folder_id/metadata/:scope/:template_keyApplies 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…
  • DELETERemove metadata instance from folder/folders/:folder_id/metadata/:scope/:template_keyDeletes a piece of folder metadata.

Metadata taxonomies

  • POSTCreate metadata taxonomy/metadata_taxonomiesCreates a new metadata taxonomy that can be used in metadata templates.
  • GETGet metadata taxonomies for namespace/metadata_taxonomies/:namespace?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Used to retrieve all metadata taxonomies in a namespace.
  • GETGet metadata taxonomy by taxonomy key/metadata_taxonomies/:namespace/:taxonomy_keyUsed to retrieve a metadata taxonomy by taxonomy key.
  • DELETERemove metadata taxonomy/metadata_taxonomies/:namespace/:taxonomy_keyDelete a metadata taxonomy. This deletion is permanent and cannot be reverted.
  • PATCHUpdate metadata taxonomy/metadata_taxonomies/:namespace/:taxonomy_keyUpdates an existing metadata taxonomy.
  • POSTCreate metadata taxonomy levels/metadata_taxonomies/:namespace/:taxonomy_key/levelsCreates new metadata taxonomy levels.
  • PATCHUpdate metadata taxonomy level/metadata_taxonomies/:namespace/:taxonomy_key/levels/:level_indexUpdates an existing metadata taxonomy level.
  • POSTAdd metadata taxonomy level/metadata_taxonomies/:namespace/:taxonomy_key/levels:appendCreates a new metadata taxonomy level and appends it to the existing levels. If there are no levels defined yet, this will create the first level.
  • POSTDelete metadata taxonomy level/metadata_taxonomies/:namespace/:taxonomy_key/levels:trimDeletes the last level of the metadata taxonomy.
  • GETList metadata taxonomy nodes/metadata_taxonomies/:namespace/:taxonomy_key/nodes?level=1&parent=c73a9bf3-f377-4210-9159-3df06a481905&ancestor=c73a9bf3-f377-4210-9159-3df06a481905,bf8b8213-be1f-4011-bd45-533c0713fa0a&query=France&include-total-result-count=true&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a query parameter is passed. With…
  • POSTCreate metadata taxonomy node/metadata_taxonomies/:namespace/:taxonomy_key/nodesCreates a new metadata taxonomy node.
  • GETGet metadata taxonomy node by ID/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_idRetrieves a metadata taxonomy node by its identifier.
  • DELETERemove metadata taxonomy node/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_idDelete a metadata taxonomy node. This deletion is permanent and cannot be reverted. Only metadata taxonomy nodes without any children can be deleted.
  • PATCHUpdate metadata taxonomy node/metadata_taxonomies/:namespace/:taxonomy_key/nodes/:node_idUpdates an existing metadata taxonomy node.
  • GETList metadata template's options for taxonomy field/metadata_templates/:namespace/:template_key/fields/:field_key/options?level=1&parent=c73a9bf3-f377-4210-9159-3df06a481905&ancestor=c73a9bf3-f377-4210-9159-3df06a481905,bf8b8213-be1f-4011-bd45-533c0713fa0a&query=France&include-total-result-count=true&only-selectable-options=true&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are…

Metadata templates

  • GETFind metadata template by instance ID/metadata_templates?metadata_instance_id=01234500-12f1-1234-aa12-b1d234cb567e&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Finds a metadata template by searching for the ID of an instance of the template.
  • GETGet metadata template by name/metadata_templates/:scope/:template_key/schemaRetrieves 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…
  • PUTUpdate metadata template/metadata_templates/:scope/:template_key/schemaUpdates a metadata template. The metadata template can only be updated if the template already exists. The update is applied atomically. If any errors occur…
  • DELETERemove metadata template/metadata_templates/:scope/:template_key/schemaDelete a metadata template and its instances. This deletion is permanent and can not be reversed.
  • GETGet metadata template by ID/metadata_templates/:template_idRetrieves a metadata template by its ID.
  • GETList all global metadata templates/metadata_templates/global?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Used to retrieve all generic, global metadata templates available to all enterprises using Box.
  • GETList all metadata templates for enterprise/metadata_templates/enterprise?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Used to retrieve all metadata templates created to be used specifically within the user's enterprise.
  • POSTCreate metadata template/metadata_templates/schemaCreates a new metadata template that can be applied to files and folders.

Recent items

  • GETList recently accessed items/recent_items?fields=id,type,name&limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiReturns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.

Retention policies

  • GETList retention policies/retention_policies?policy_name=Sales Policy&policy_type=finite&created_by_user_id=21312321&fields=id,type,name&limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiRetrieves all of the retention policies for an enterprise.
  • POSTCreate retention policy/retention_policiesCreates a retention policy.
  • GETGet retention policy/retention_policies/:retention_policy_id?fields=id,type,nameRetrieves a retention policy.
  • PUTUpdate retention policy/retention_policies/:retention_policy_idUpdates a retention policy.
  • DELETEDelete retention policy/retention_policies/:retention_policy_idPermanently deletes a retention policy.

Retention policy assignments

  • GETList retention policy assignments/retention_policies/:retention_policy_id/assignments?type=metadata_template&fields=id,type,name&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Returns a list of all retention policy assignments associated with a specified retention policy.
  • POSTAssign retention policy/retention_policy_assignmentsAssigns a retention policy to an item.
  • GETGet retention policy assignment/retention_policy_assignments/:retention_policy_assignment_id?fields=id,type,nameRetrieves a retention policy assignment.
  • DELETERemove retention policy assignment/retention_policy_assignments/:retention_policy_assignment_idRemoves a retention policy assignment applied to content.
  • GETGet files under retention/retention_policy_assignments/:retention_policy_assignment_id/files_under_retention?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Returns a list of files under retention for a retention policy assignment.
  • GETGet file versions under retention/retention_policy_assignments/:retention_policy_assignment_id/file_versions_under_retention?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Returns a list of file versions under retention for a retention policy assignment.

Search

  • POSTQuery files/folders by metadata/metadata_queries/execute_readFor new integrations, use the v2026.0 Query API. This is the latest version of the Query API, with advanced capabilities including multi-template queries and…
  • GETSearch for content/search?query=sales&scope=user_content&file_extensions=pdf,png,gif&created_at_range=2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00&updated_at_range=2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00&size_range=1000000,5000000&owner_user_ids=123422,23532,3241212&recent_updater_user_ids=123422,23532,3241212&ancestor_folder_ids=4535234,234123235,2654345&content_types=name,description&type=file&trash_content=non_trashed_only&mdfilters={"scope":"enterprise","templateKey":"contract","filters":[{"category":"online"},{"contractValue":100000}]}&sort=modified_at&direction=ASC&limit=100&include_recent_shared_links=true&fields=id,type,name&offset=1000&deleted_user_ids=123422,23532,3241212&deleted_at_range=2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Session termination

  • POSTCreate jobs to terminate users session/users/terminate_sessionsValidates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.
  • POSTCreate jobs to terminate user group session/groups/terminate_sessionsValidates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.

Shared links (App Items)

  • GETFind app item for shared link/shared_items#app_itemsReturns the app item represented by a shared link. The link can originate from the current enterprise or another.

Shared links (Files)

  • GETFind file for shared link/shared_items?fields=id,type,nameReturns 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…
  • GETGet shared link for file/files/:file_id#get_shared_link?fields=shared_linkGets the information for a shared link on a file.
  • PUTAdd shared link to file/files/:file_id#add_shared_link?fields=shared_linkAdds a shared link to a file.
  • PUTUpdate shared link on file/files/:file_id#update_shared_link?fields=shared_linkUpdates a shared link on a file.
  • PUTRemove shared link from file/files/:file_id#remove_shared_link?fields=shared_linkRemoves a shared link from a file.

Shared links (Folders)

  • GETFind folder for shared link/shared_items#folders?fields=id,type,nameReturn 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…
  • GETGet shared link for folder/folders/:folder_id#get_shared_link?fields=shared_linkGets the information for a shared link on a folder.
  • PUTAdd shared link to folder/folders/:folder_id#add_shared_link?fields=shared_linkAdds a shared link to a folder.
  • PUTUpdate shared link on folder/folders/:folder_id#update_shared_link?fields=shared_linkUpdates a shared link on a folder.
  • PUTRemove shared link from folder/folders/:folder_id#remove_shared_link?fields=shared_linkRemoves a shared link from a folder.

Shared links (Web Links)

  • GETFind web link for shared link/shared_items#web_links?fields=id,type,nameReturns 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…
  • GETGet shared link for web link/web_links/:web_link_id#get_shared_link?fields=shared_linkGets the information for a shared link on a web link.
  • PUTAdd shared link to web link/web_links/:web_link_id#add_shared_link?fields=shared_linkAdds a shared link to a web link.
  • PUTUpdate shared link on web link/web_links/:web_link_id#update_shared_link?fields=shared_linkUpdates a shared link on a web link.
  • PUTRemove shared link from web link/web_links/:web_link_id#remove_shared_link?fields=shared_linkRemoves a shared link from a web link.

Shield information barrier reports

  • GETList shield information barrier reports/shield_information_barrier_reports?shield_information_barrier_id=1910967&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Lists shield information barrier reports.
  • POSTCreate shield information barrier report/shield_information_barrier_reportsCreates a shield information barrier report for a given barrier.
  • GETGet shield information barrier report by ID/shield_information_barrier_reports/:shield_information_barrier_report_idRetrieves a shield information barrier report by its ID.

Shield information barrier segment members

  • GETGet shield information barrier segment member by ID/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_idRetrieves a shield information barrier segment member by its ID.
  • DELETEDelete shield information barrier segment member by ID/shield_information_barrier_segment_members/:shield_information_barrier_segment_member_idDeletes a shield information barrier segment member based on provided ID.
  • GETList shield information barrier segment members/shield_information_barrier_segment_members?shield_information_barrier_segment_id=3423&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Lists shield information barrier segment members based on provided segment IDs.
  • POSTCreate shield information barrier segment member/shield_information_barrier_segment_membersCreates a new shield information barrier segment member.

Shield information barrier segment restrictions

  • GETGet shield information barrier segment restriction by ID/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_idRetrieves a shield information barrier segment restriction based on provided ID.
  • DELETEDelete shield information barrier segment restriction by ID/shield_information_barrier_segment_restrictions/:shield_information_barrier_segment_restriction_idDelete shield information barrier segment restriction based on provided ID.
  • GETList shield information barrier segment restrictions/shield_information_barrier_segment_restrictions?shield_information_barrier_segment_id=3423&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Lists shield information barrier segment restrictions based on provided segment ID.
  • POSTCreate shield information barrier segment restriction/shield_information_barrier_segment_restrictionsCreates a shield information barrier segment restriction object.

Shield information barrier segments

  • GETGet shield information barrier segment with specified ID/shield_information_barrier_segments/:shield_information_barrier_segment_idRetrieves shield information barrier segment based on provided ID..
  • PUTUpdate shield information barrier segment with specified ID/shield_information_barrier_segments/:shield_information_barrier_segment_idUpdates the shield information barrier segment based on provided ID..
  • DELETEDelete shield information barrier segment/shield_information_barrier_segments/:shield_information_barrier_segment_idDeletes the shield information barrier segment based on provided ID.
  • GETList shield information barrier segments/shield_information_barrier_segments?shield_information_barrier_id=1910967&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.
  • POSTCreate shield information barrier segment/shield_information_barrier_segmentsCreates a shield information barrier segment.

Shield information barriers

  • GETGet shield information barrier with specified ID/shield_information_barriers/:shield_information_barrier_idGet shield information barrier based on provided ID.
  • POSTAdd changed status of shield information barrier with specified ID/shield_information_barriers/change_statusChange status of shield information barrier with the specified ID.
  • GETList shield information barriers/shield_information_barriers?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Retrieves a list of shield information barrier objects for the enterprise of JWT.
  • POSTCreate shield information barrier/shield_information_barriersCreates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.

Skills

  • GETList Box Skill cards on file/files/:file_id/metadata/global/boxSkillsCardsList the Box Skills metadata cards that are attached to a file.
  • PUTUpdate Box Skill cards on file/files/:file_id/metadata/global/boxSkillsCardsUpdates one or more Box Skills metadata cards to a file.
  • POSTCreate Box Skill cards on file/files/:file_id/metadata/global/boxSkillsCardsApplies one or more Box Skills metadata cards to a file.
  • DELETERemove Box Skill cards from file/files/:file_id/metadata/global/boxSkillsCardsRemoves any Box Skills cards metadata from a file.
  • PUTUpdate all Box Skill cards on file/skill_invocations/:skill_idAn alternative method that can be used to overwrite and update all Box Skill metadata cards on a file.

Standard and Zones Storage Policies

  • GETList storage policies/storage_policies?fields=id,type,name&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Fetches all the storage policies in the enterprise.
  • GETGet storage policy/storage_policies/:storage_policy_idFetches a specific storage policy.

Standard and Zones Storage Policy Assignments

  • GETList storage policy assignments/storage_policy_assignments?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&resolved_for_type=user&resolved_for_id=984322Fetches all the storage policy assignment for an enterprise or user.
  • POSTAssign storage policy/storage_policy_assignmentsCreates a storage policy assignment for an enterprise or user.
  • GETGet storage policy assignment/storage_policy_assignments/:storage_policy_assignment_idFetches a specific storage policy assignment.
  • PUTUpdate storage policy assignment/storage_policy_assignments/:storage_policy_assignment_idUpdates a specific storage policy assignment.
  • DELETEUnassign storage policy/storage_policy_assignments/:storage_policy_assignment_idDelete a storage policy assignment. Deleting a storage policy assignment on a user will have the user inherit the enterprise's default storage policy. There…

Task assignments

  • GETList task assignments/tasks/:task_id/assignmentsLists all of the assignments for a given task.
  • POSTAssign task/task_assignmentsAssigns a task to a user. A task can be assigned to more than one user by creating multiple assignments.
  • GETGet task assignment/task_assignments/:task_assignment_idRetrieves information about a task assignment.
  • PUTUpdate task assignment/task_assignments/:task_assignment_idUpdates a task assignment. This endpoint can be used to update the state of a task assigned to a user.
  • DELETEUnassign task/task_assignments/:task_assignment_idDeletes a specific task assignment.

Tasks

  • GETList tasks on file/files/:file_id/tasksRetrieves a list of all the tasks for a file. This endpoint does not support pagination.
  • POSTCreate task/tasksCreates a single task on a file. This task is not assigned to any user and will need to be assigned separately.
  • GETGet task/tasks/:task_idRetrieves information about a specific task.
  • PUTUpdate task/tasks/:task_idUpdates a task. This can be used to update a task's configuration, or to update its completion state.
  • DELETERemove task/tasks/:task_idRemoves a task from a file.

Terms of service

  • GETList terms of services/terms_of_services?tos_type=managedReturns the current terms of service text and settings for the enterprise.
  • POSTCreate terms of service/terms_of_servicesCreates a terms of service for a given enterprise and type of user.
  • GETGet terms of service/terms_of_services/:terms_of_service_idFetches a specific terms of service.
  • PUTUpdate terms of service/terms_of_services/:terms_of_service_idUpdates a specific terms of service.

Terms of service user statuses

  • GETList terms of service user statuses/terms_of_service_user_statuses?tos_id=324234&user_id=123334Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.
  • POSTCreate terms of service status for new user/terms_of_service_user_statusesSets the status for a terms of service for a user.
  • PUTUpdate terms of service status for existing user/terms_of_service_user_statuses/:terms_of_service_user_status_idUpdates the status for a terms of service for a user.

Transfer folders

  • PUTTransfer owned folders/users/:user_id/folders/0?fields=id,type,name&notify=trueMove 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…

Trashed files

  • POSTRestore file/files/:file_id?fields=id,type,nameRestores 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.
  • GETGet trashed file/files/:file_id/trash?fields=id,type,nameRetrieves 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…
  • DELETEPermanently remove file/files/:file_id/trashPermanently deletes a file that is in the trash. This action cannot be undone.

Trashed folders

  • POSTRestore folder/folders/:folder_id?fields=id,type,nameRestores 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…
  • GETGet trashed folder/folders/:folder_id/trash?fields=id,type,nameRetrieves 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…
  • DELETEPermanently remove folder/folders/:folder_id/trashPermanently deletes a folder that is in the trash. This action cannot be undone.

Trashed items

  • GETList trashed items/folders/trash/items?fields=id,type,name&limit=1000&offset=1000&usemarker=true&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&direction=ASC&sort=nameRetrieves 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…

Trashed web links

  • POSTRestore web link/web_links/:web_link_id?fields=id,type,nameRestores 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…
  • GETGet trashed web link/web_links/:web_link_id/trash?fields=id,type,nameRetrieves a web link that has been moved to the trash.
  • DELETEPermanently remove web link/web_links/:web_link_id/trashPermanently deletes a web link that is in the trash. This action cannot be undone.

Uploads

  • POSTUpload file versionhttps://upload.box.com/api/2.0/files/:file_id/content?fields=id,type,nameUpdate 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.…
  • POSTUpload filehttps://upload.box.com/api/2.0/files/content?fields=id,type,nameUploads 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…

Uploads (Chunked)

  • POSTCreate upload sessionhttps://upload.box.com/api/2.0/files/upload_sessionsCreates an upload session for a new file.
  • POSTCreate upload session for existing filehttps://upload.box.com/api/2.0/files/:file_id/upload_sessionsCreates an upload session for an existing file.
  • GETGet upload sessionhttps://upload.box.com/api/2.0/files/upload_sessions/:upload_session_idReturn information about an upload session. The actual endpoint URL is returned by the Create upload session endpoint.
  • PUTUpload part of filehttps://upload.box.com/api/2.0/files/upload_sessions/:upload_session_idUploads a chunk of a file for an upload session. The actual endpoint URL is returned by the Create upload session and Get upload session endpoints.
  • DELETERemove upload sessionhttps://upload.box.com/api/2.0/files/upload_sessions/:upload_session_idAbort an upload session and discard all data uploaded. This cannot be reversed. The actual endpoint URL is returned by the Create upload session and Get…
  • GETList partshttps://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/parts?offset=1000&limit=1000Return a list of the chunks uploaded to the upload session so far. The actual endpoint URL is returned by the Create upload session and Get upload session…
  • POSTPlan upload sessionhttps://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/planPlan an upload session by checking which parts already exist on the server. This endpoint allows clients to optimize uploads by skipping parts that have…
  • POSTCommit upload sessionhttps://upload.box.com/api/2.0/files/upload_sessions/:upload_session_id/commitClose an upload session and create a file from the uploaded chunks. The actual endpoint URL is returned by the Create upload session and Get upload session…

User avatars

  • GETGet user avatar/users/:user_id/avatarRetrieves an image of a the user's avatar.
  • POSTAdd or update user avatar/users/:user_id/avatarAdds or updates a user avatar.
  • DELETEDelete user avatar/users/:user_id/avatarRemoves an existing user avatar. You cannot reverse this operation.

Users

  • GETList enterprise users/users?filter_term=john&user_type=managed&external_app_user_id=my-user-1234&fields=id,type,name&offset=1000&limit=1000&usemarker=true&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiReturns 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…
  • POSTCreate user/users?fields=id,type,nameCreates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
  • GETGet current user/users/me?fields=id,type,nameRetrieves 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…
  • GETGet user/users/:user_id?fields=id,type,nameRetrieves 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…
  • PUTUpdate user/users/:user_id?fields=id,type,nameUpdates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.
  • DELETEDelete user/users/:user_id?notify=true&force=trueDeletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the force parameter to…

Watermarks (Files)

  • GETGet watermark on file/files/:file_id/watermarkRetrieve the watermark for a file.
  • PUTApply watermark to file/files/:file_id/watermarkApplies or update a watermark on a file.
  • DELETERemove watermark from file/files/:file_id/watermarkRemoves the watermark from a file.

Watermarks (Folders)

  • GETGet watermark for folder/folders/:folder_id/watermarkRetrieve the watermark for a folder.
  • PUTApply watermark to folder/folders/:folder_id/watermarkApplies or update a watermark on a folder.
  • DELETERemove watermark from folder/folders/:folder_id/watermarkRemoves the watermark from a folder.

Web links

  • POSTCreate web link/web_linksCreates a web link object within a folder.
  • GETGet web link/web_links/:web_link_idRetrieve information about a web link.
  • PUTUpdate web link/web_links/:web_link_idUpdates a web link object.
  • DELETERemove web link/web_links/:web_link_idDeletes a web link.

Webhooks

  • GETList all webhooks/webhooks?marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii&limit=1000Returns all defined webhooks for the requesting application. This API only returns webhooks that are applied to files or folders that are owned by the…
  • POSTCreate webhook/webhooksCreates a webhook.
  • GETGet webhook/webhooks/:webhook_idRetrieves a specific webhook.
  • PUTUpdate webhook/webhooks/:webhook_idUpdates a webhook.
  • DELETERemove webhook/webhooks/:webhook_idDeletes a webhook.

Workflows

  • GETList workflows/workflows?folder_id=12345&trigger_type=WORKFLOW_MANUAL_START&limit=1000&marker=JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioViiReturns 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…
  • POSTStarts workflow based on request body/workflows/:workflow_id/startInitiates 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…

Zip Downloads

  • POSTCreate zip download/zip_downloadsCreates 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…
  • GETDownload zip archivehttps://dl.boxcloud.com/2.0/zip_downloads/:zip_download_id/contentReturns 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…
  • GETGet zip download status/zip_downloads/:zip_download_id/statusReturns 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…

API details

Base URL
https://api.box.com/2.0
Authentication
OAuth 2.0 (authorization code flow) with 9 scopes
Operations
297 operations on 187 pathsGET 129POST 74DELETE 45PUT 44PATCH 3OPTIONS 2
Main resources
Metadata taxonomies 15Integration mappings 8Metadata templates 8Uploads (Chunked) 8Files 6Folders 6Group memberships 6Legal hold policy assignments 6Retention policy assignments 6Users 6
Response formats
application/json application/octet-stream image/jpg text/html
Description format
OpenAPI 3.0.2, API version 2024.0

How to test the Box Platform API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Box Platform API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 9 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Ask question” (POST /ai/ask), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Box Platform API?

[Box Platform](https://developer.box.com) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for… It is listed under Data & analytics and has 297 endpoints.

Who publishes the Box Platform API?

It is listed from Box's public API description (an OpenAPI document), not published by Box on Swastik Codes. Anyone who controls box.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Box Platform API?

Requests go to https://api.box.com/2.0. Endpoint paths are added to this base URL.

How do I authenticate with the Box Platform API?

With OAuth 2.0 (authorization code flow) with 9 scopes.

How many endpoints does the Box Platform API have?

297 operations on 187 paths (129 GET, 74 POST, 45 DELETE, 44 PUT, 3 PATCH, 2 OPTIONS). The largest groups are Metadata taxonomies, Integration mappings, Metadata templates, Uploads (Chunked).

Is forking the Box Platform API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.