Skip to content
Changelog

Report a bug

Box integration: operations for AI agents

Box connects to Type.com as an integration. This page lists the 379 operations documented for Claude and Codex in Type.com: 171 read, 95 write, 113 destructive.

About Box

Box API reference operations, subject to Type connection, account permissions and API version.

Categories: Files & Storage

How to connect Box to Type.com

Connect
Use a managed Box connection with the required proxy configuration and authorization.
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

379 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

379 operations listed.

Authorization

  • Read

    Authorize user

    Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf. This is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.

    GET /authorize

  • Write

    Request access token

    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 [authorize](https://developer.box.com/reference/get-authorize) 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.

    POST /oauth2/token

  • Write

    Refresh access token

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

    POST /oauth2/token

  • Destructive

    Revoke access token

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

    POST /oauth2/revoke

Files

  • Read

    Get file information

    Retrieves the details about a file.

    GET /files/{file_id}

  • Read

    Get file thumbnail

    Retrieves a thumbnail, or smaller image representation, of a file. Sizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format. Thumbnails can be generated for the image and video file formats listed [found on our community site][1]. [1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

    GET /files/{file_id}/thumbnail.{extension}

  • Write

    Copy file

    Creates a copy of a file.

    POST /files/{file_id}/copy

  • Destructive

    Update file

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

    PUT /files/{file_id}

  • Destructive

    Delete file

    Deletes 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 moved to the trash.

    DELETE /files/{file_id}

Trashed files

  • Read

    Get trashed file

    Retrieves a file that has been moved to the trash. Please note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API. To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/) API.

    GET /files/{file_id}/trash

  • Write

    Restore file

    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.

    POST /files/{file_id}

  • Destructive

    Permanently remove file

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

    DELETE /files/{file_id}/trash

App item associations

  • Read

    List file app item associations

    **This is a beta feature, which means that its availability might be limited.** Returns all app items the file is associated with. This includes app items associated with ancestors of the file. Assuming the context user has access to the file, the type/ids are revealed even if the context user does not have **View** permission on the app item.

    GET /files/{file_id}/app_item_associations

  • Read

    List folder app item associations

    **This is a beta feature, which means that its availability might be limited.** Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have **View** permission on the app item.

    GET /folders/{folder_id}/app_item_associations

Downloads

  • Read

    Download file

    Returns the contents of a file in binary format.

    GET /files/{file_id}/content

Uploads

  • Write

    Upload file version

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

    POST /files/{file_id}/content

  • Write

    Upload file

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

    POST /files/content

Uploads (Chunked)

  • Read

    Get upload session

    Return information about an upload session. The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) endpoint.

    GET /files/upload_sessions/{upload_session_id}

  • Read

    List parts

    Return a list of the chunks uploaded to the upload session so far. The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

    GET /files/upload_sessions/{upload_session_id}/parts

  • Write

    Create upload session

    Creates an upload session for a new file.

    POST /files/upload_sessions

  • Write

    Create upload session for existing file

    Creates an upload session for an existing file.

    POST /files/{file_id}/upload_sessions

  • Write

    Plan upload session

    Plan an upload session by checking which parts already exist on the server. This endpoint allows clients to optimize uploads by skipping parts that have already been uploaded (cache hits) and only uploading missing parts. The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

    POST /files/upload_sessions/{upload_session_id}/plan

  • Write

    Commit upload session

    Close an upload session and create a file from the uploaded chunks. The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

    POST /files/upload_sessions/{upload_session_id}/commit

  • Destructive

    Upload part of file

    Uploads a chunk of a file for an upload session. The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

    PUT /files/upload_sessions/{upload_session_id}

  • Destructive

    Remove upload session

    Abort an upload session and discard all data uploaded. This cannot be reversed. The actual endpoint URL is returned by the [`Create upload session`](https://developer.box.com/reference/post-files-upload-sessions) and [`Get upload session`](https://developer.box.com/reference/get-files-upload-sessions-id) endpoints.

    DELETE /files/upload_sessions/{upload_session_id}

Collaborations (List)

  • Read

    List file collaborations

    Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

    GET /files/{file_id}/collaborations

  • Read

    List folder collaborations

    Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.

    GET /folders/{folder_id}/collaborations

  • Read

    List pending collaborations

    Retrieves all pending collaboration invites for this user.

    GET /collaborations

  • Read

    List group collaborations

    Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups. Each collaboration object has details on which files or folders the group has access to and with what role.

    GET /groups/{group_id}/collaborations

Comments

  • Read

    List file comments

    Retrieves a list of comments for a file.

    GET /files/{file_id}/comments

  • Read

    Get comment

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

    GET /comments/{comment_id}

  • Write

    Create comment

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

    POST /comments

  • Destructive

    Update comment

    Update the message of a comment.

    PUT /comments/{comment_id}

  • Destructive

    Remove comment

    Permanently deletes a comment.

    DELETE /comments/{comment_id}

Tasks

  • Read

    List tasks on file

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

    GET /files/{file_id}/tasks

  • Read

    Get task

    Retrieves information about a specific task.

    GET /tasks/{task_id}

  • Write

    Create task

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

    POST /tasks

  • Destructive

    Update task

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

    PUT /tasks/{task_id}

  • Destructive

    Remove task

    Removes a task from a file.

    DELETE /tasks/{task_id}

File versions

  • Read

    List all file versions

    Retrieve a list of the past versions for a file. Versions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.

    GET /files/{file_id}/versions

  • Read

    Get file version

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

    GET /files/{file_id}/versions/{file_version_id}

  • Write

    Promote file version

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

    POST /files/{file_id}/versions/current

  • Destructive

    Remove file version

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

    DELETE /files/{file_id}/versions/{file_version_id}

  • Destructive

    Restore file version

    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.

    PUT /files/{file_id}/versions/{file_version_id}

Metadata instances (Files)

  • Read

    List metadata instances on file

    Retrieves all metadata for a given file.

    GET /files/{file_id}/metadata

  • Read

    Get metadata instance on file

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

    GET /files/{file_id}/metadata/{scope}/{template_key}

  • Write

    Create metadata instance on file

    Applies an instance of a metadata template to a file. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.

    POST /files/{file_id}/metadata/{scope}/{template_key}

  • Destructive

    Update metadata instance on file

    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.

    PUT /files/{file_id}/metadata/{scope}/{template_key}

  • Destructive

    Remove metadata instance from file

    Deletes a piece of file metadata.

    DELETE /files/{file_id}/metadata/{scope}/{template_key}

Classifications on files

  • Read

    Get classification on file

    Retrieves the classification metadata instance that has been applied to a file. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

    GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo

  • Write

    Add classification to file

    Adds a classification to a file by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

    POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo

  • Destructive

    Update classification on file

    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.

    PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo

  • Destructive

    Remove classification from file

    Removes any classifications from a file. This API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.

    DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo

Skills

  • Read

    List Box Skill cards on file

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

    GET /files/{file_id}/metadata/global/boxSkillsCards

  • Write

    Create Box Skill cards on file

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

    POST /files/{file_id}/metadata/global/boxSkillsCards

  • Destructive

    Update Box Skill cards on file

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

    PUT /files/{file_id}/metadata/global/boxSkillsCards

  • Destructive

    Remove Box Skill cards from file

    Removes any Box Skills cards metadata from a file.

    DELETE /files/{file_id}/metadata/global/boxSkillsCards

  • Destructive

    Update all Box Skill cards on file

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

    PUT /skill_invocations/{skill_id}

Watermarks (Files)

  • Read

    Get watermark on file

    Retrieve the watermark for a file.

    GET /files/{file_id}/watermark

  • Destructive

    Apply watermark to file

    Applies or update a watermark on a file.

    PUT /files/{file_id}/watermark

  • Destructive

    Remove watermark from file

    Removes the watermark from a file.

    DELETE /files/{file_id}/watermark

File requests

  • Read

    Get file request

    Retrieves the information about a file request.

    GET /file_requests/{file_request_id}

  • Write

    Copy file request

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

    POST /file_requests/{file_request_id}/copy

  • Destructive

    Update file request

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

    PUT /file_requests/{file_request_id}

  • Destructive

    Delete file request

    Deletes a file request permanently.

    DELETE /file_requests/{file_request_id}

Folders

  • Read

    Get folder information

    Retrieves details for a folder, including the first 100 entries in the folder. Passing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](https://developer.box.com/reference/resources/folder--full#param-item-collection). To fetch more items within the folder, use the [Get items in a folder](https://developer.box.com/reference/get-folders-id-items) endpoint.

    GET /folders/{folder_id}

  • Read

    List items in folder

    Retrieves a page of items in a folder. These items can be files, folders, and web links. To request more information about the folder itself, like its size, use the [Get a folder](https://developer.box.com/reference/get-folders-id) endpoint instead.

    GET /folders/{folder_id}/items

  • Write

    Create folder

    Creates a new empty folder within the specified parent folder.

    POST /folders

  • Write

    Copy folder

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

    POST /folders/{folder_id}/copy

  • Destructive

    Update folder

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

    PUT /folders/{folder_id}

  • Destructive

    Delete folder

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

    DELETE /folders/{folder_id}

Trashed folders

  • Read

    Get trashed folder

    Retrieves a folder that has been moved to the trash. Please note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](https://developer.box.com/reference/get-folders-id-trash) API. To list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](https://developer.box.com/reference/get-folders-trash-items/) API.

    GET /folders/{folder_id}/trash

  • Write

    Restore folder

    Restores a folder that has been moved to the trash. An optional new parent ID can be provided to restore the folder to in case the original folder has been deleted. During this operation, part of the 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.

    POST /folders/{folder_id}

  • Destructive

    Permanently remove folder

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

    DELETE /folders/{folder_id}/trash

Metadata instances (Folders)

  • Read

    List metadata instances on folder

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

    GET /folders/{folder_id}/metadata

  • Read

    Get metadata instance on folder

    Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.

    GET /folders/{folder_id}/metadata/{scope}/{template_key}

  • Write

    Create metadata instance on folder

    Applies an instance of a metadata template to a folder. In most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair. To display the metadata template in the Box web app the enterprise needs to be configured to enable **Cascading Folder Level Metadata** for the user in the admin console.

    POST /folders/{folder_id}/metadata/{scope}/{template_key}

  • Destructive

    Update metadata instance on folder

    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.

    PUT /folders/{folder_id}/metadata/{scope}/{template_key}

  • Destructive

    Remove metadata instance from folder

    Deletes a piece of folder metadata.

    DELETE /folders/{folder_id}/metadata/{scope}/{template_key}

Classifications on folders

  • Read

    Get classification on folder

    Retrieves the classification metadata instance that has been applied to a folder. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

    GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo

  • Write

    Add classification to folder

    Adds a classification to a folder by specifying the label of the classification to add. This API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.

    POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo

  • Destructive

    Update classification on folder

    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.

    PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo

  • Destructive

    Remove classification from folder

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

    DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo

Trashed items

  • Read

    List trashed items

    Retrieves the files and folders that have been moved to the trash. Any attribute in the full files or folders objects can be passed in with the `fields` parameter to retrieve those specific attributes that are not returned by default. This endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the `marker` parameter. The number of entries returned may be less than `total_count`. For example, if a user deletes items from a shared folder and is later removed as a collaborator, those deleted items will no longer appear in this endpoint’s results, even though they are still included in `total_count`.

    GET /folders/trash/items

Watermarks (Folders)

  • Read

    Get watermark for folder

    Retrieve the watermark for a folder.

    GET /folders/{folder_id}/watermark

  • Destructive

    Apply watermark to folder

    Applies or update a watermark on a folder.

    PUT /folders/{folder_id}/watermark

  • Destructive

    Remove watermark from folder

    Removes the watermark from a folder.

    DELETE /folders/{folder_id}/watermark

Folder Locks

  • Read

    List folder locks

    Retrieves folder lock details for a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

    GET /folder_locks

  • Destructive

    Create folder lock

    Creates a folder lock on a folder, preventing it from being moved and/or deleted. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

    POST /folder_locks

  • Destructive

    Delete folder lock

    Deletes a folder lock on a given folder. You must be authenticated as the owner or co-owner of the folder to use this endpoint.

    DELETE /folder_locks/{folder_lock_id}

Metadata templates

  • Read

    Find metadata template by instance ID

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

    GET /metadata_templates

  • Read

    Get metadata template by name

    Retrieves a metadata template by its `scope` and `templateKey` values. To find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

    GET /metadata_templates/{scope}/{template_key}/schema

  • Read

    Get metadata template by ID

    Retrieves a metadata template by its ID.

    GET /metadata_templates/{template_id}

  • Read

    List all global metadata templates

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

    GET /metadata_templates/global

  • Read

    List all metadata templates for enterprise

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

    GET /metadata_templates/enterprise

  • Write

    Create metadata template

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

    POST /metadata_templates/schema

  • Destructive

    Update metadata template

    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.

    PUT /metadata_templates/{scope}/{template_key}/schema

  • Destructive

    Remove metadata template

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

    DELETE /metadata_templates/{scope}/{template_key}/schema

Classifications

  • Read

    List all classifications

    Retrieves the classification metadata template and lists all the classifications available to this enterprise. This API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.

    GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

  • Write

    Add initial classifications

    When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications. If an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.

    POST /metadata_templates/schema

  • Destructive

    Add classification

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

    PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

  • Destructive

    Update classification

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

    PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema

Metadata cascade policies

  • Read

    List metadata cascade policies

    Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.

    GET /metadata_cascade_policies

  • Read

    Get metadata cascade policy

    Retrieve a specific metadata cascade policy assigned to a folder.

    GET /metadata_cascade_policies/{metadata_cascade_policy_id}

  • Write

    Create metadata cascade policy

    Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder. In order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.

    POST /metadata_cascade_policies

  • Destructive

    Remove metadata cascade policy

    Deletes a metadata cascade policy.

    DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}

  • Destructive

    Force-apply metadata cascade policy to folder

    Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.

    POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply

Search

  • Read

    Query files/folders by metadata

    For new integrations, use the [v2026.0 Query API](https://developer.box.com/reference/v2026.0/query-resources). This is the latest version of the Query API, with advanced capabilities including multi-template queries and Query Insights, and is the API we will continue to enhance with new Query capabilities. 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.

    POST /metadata_queries/execute_read

Collaborations

  • Read

    Get collaboration

    Retrieves a single collaboration.

    GET /collaborations/{collaboration_id}

  • Write

    Create collaboration

    Adds a collaboration for a single user or a single group to a file or folder. Collaborations can be created using email address, user IDs, or a group IDs. If a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited. If collaboration is in `pending` status, field `name` is redacted when: - a collaboration was created using `user_id`, - a collaboration was created using `login`.

    POST /collaborations

  • Destructive

    Update collaboration

    Updates 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 not required.

    PUT /collaborations/{collaboration_id}

  • Destructive

    Remove collaboration

    Deletes a single collaboration.

    DELETE /collaborations/{collaboration_id}

Task assignments

  • Read

    List task assignments

    Lists all of the assignments for a given task.

    GET /tasks/{task_id}/assignments

  • Read

    Get task assignment

    Retrieves information about a task assignment.

    GET /task_assignments/{task_assignment_id}

  • Write

    Assign task

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

    POST /task_assignments

  • Destructive

    Update task assignment

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

    PUT /task_assignments/{task_assignment_id}

  • Destructive

    Unassign task

    Deletes a specific task assignment.

    DELETE /task_assignments/{task_assignment_id}

Shared links (Files)

  • Read

    Find file for shared link

    Returns the file represented by a shared link. A shared file can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared file when only given a shared link. The `shared_link_permission_options` array field can be returned by requesting it in the `fields` query parameter.

    GET /shared_items

Shared links (Folders)

  • Read

    Find folder for shared link

    Return the folder represented by a shared link. A shared folder can be represented by a shared link, which can originate within the current enterprise or within another. This endpoint allows an application to retrieve information about a shared folder when only given a shared link.

    GET /shared_items

Web links

  • Write

    Create web link

    Creates a web link object within a folder.

    POST /web_links

Trashed web links

  • Write

    Restore web link

    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.

    POST /web_links/{web_link_id}

Shared links (Web Links)

Shared links (App Items)

  • Read

    Find app item for shared link

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

    GET /shared_items

Users

  • Read

    List enterprise users

    Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`. The application and the authenticated user need to have the permission to look up users in the entire enterprise.

    GET /users

  • Read

    Get current user

    Retrieves information about the user who is currently authenticated. In the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app. In the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default. Use the `As-User` header to change who this API call is made on behalf of.

    GET /users/me

  • Read

    Get user

    Retrieves information about a user in the enterprise. The application and the authenticated user need to have the permission to look up users in the entire enterprise. This endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.

    GET /users/{user_id}

  • Write

    Create user

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

    POST /users

  • Destructive

    Update user

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

    PUT /users/{user_id}

  • Destructive

    Delete user

    Deletes 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 delete the user and their files. If the enterprise has a retention policy, including a retired one, or a legal hold that is not fully released, you can't delete a user who owns content, even with `force`. Transfer the user's content first by using the [Transfer owned folders](https://developer.box.com/reference/put-users-id-folders-0) endpoint.

    DELETE /users/{user_id}

Session termination

  • Write

    Create jobs to terminate users session

    Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.

    POST /users/terminate_sessions

  • Write

    Create jobs to terminate user group session

    Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.

    POST /groups/terminate_sessions

User avatars

  • Read

    Get user avatar

    Retrieves an image of a the user's avatar.

    GET /users/{user_id}/avatar

  • Write

    Add or update user avatar

    Adds or updates a user avatar.

    POST /users/{user_id}/avatar

  • Destructive

    Delete user avatar

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

    DELETE /users/{user_id}/avatar

Transfer folders

  • Destructive

    Transfer owned folders

    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. If the user has a large number of items across all folders, the call will be run asynchronously. If the operation is not completed within 10 minutes, the user will receive a 200 OK response, and the operation will continue running. 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.

    PUT /users/{user_id}/folders/0

Email aliases

  • Read

    List user's email aliases

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

    GET /users/{user_id}/email_aliases

  • Write

    Create email alias

    Adds a new email alias to a user account..

    POST /users/{user_id}/email_aliases

  • Destructive

    Remove email alias

    Removes an email alias from a user.

    DELETE /users/{user_id}/email_aliases/{email_alias_id}

Group memberships

  • Read

    List user's groups

    Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.

    GET /users/{user_id}/memberships

  • Read

    List members of group

    Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.

    GET /groups/{group_id}/memberships

  • Read

    Get group membership

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

    GET /group_memberships/{group_membership_id}

  • Write

    Add user to group

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

    POST /group_memberships

  • Destructive

    Update group membership

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

    PUT /group_memberships/{group_membership_id}

  • Destructive

    Remove user from group

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

    DELETE /group_memberships/{group_membership_id}

Invites

  • Read

    Get user invite status

    Returns the status of a user invite.

    GET /invites/{invite_id}

  • Write

    Create user invite

    Invites an existing external user to join an enterprise. The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application. This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.

    POST /invites

Groups

  • Read

    List groups for enterprise

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

    GET /groups

  • Read

    Get group

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

    GET /groups/{group_id}

  • Write

    Create group

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

    POST /groups

  • Destructive

    Update group

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

    PUT /groups/{group_id}

  • Destructive

    Remove group

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

    DELETE /groups/{group_id}

Webhooks

  • Read

    List all webhooks

    Returns all defined webhooks for the requesting application. This API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.

    GET /webhooks

  • Read

    Get webhook

    Retrieves a specific webhook.

    GET /webhooks/{webhook_id}

  • Write

    Create webhook

    Creates a webhook.

    POST /webhooks

  • Destructive

    Update webhook

    Updates a webhook.

    PUT /webhooks/{webhook_id}

  • Destructive

    Remove webhook

    Deletes a webhook.

    DELETE /webhooks/{webhook_id}

Events

  • Read

    List user and enterprise events

    Returns up to a year of past events for a given user or for the entire enterprise. By default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.

    GET /events

Collections

  • Read

    List all collections

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

    GET /collections

  • Read

    List collection items

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

    GET /collections/{collection_id}/items

  • Read

    Get collection by ID

    Retrieves a collection by its ID.

    GET /collections/{collection_id}

Recent items

  • Read

    List recently accessed items

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

    GET /recent_items

Retention policies

  • Read

    List retention policies

    Retrieves all of the retention policies for an enterprise.

    GET /retention_policies

  • Read

    Get retention policy

    Retrieves a retention policy.

    GET /retention_policies/{retention_policy_id}

  • Destructive

    Create retention policy

    Creates a retention policy.

    POST /retention_policies

  • Destructive

    Update retention policy

    Updates a retention policy.

    PUT /retention_policies/{retention_policy_id}

  • Destructive

    Delete retention policy

    Permanently deletes a retention policy.

    DELETE /retention_policies/{retention_policy_id}

Retention policy assignments

  • Read

    List retention policy assignments

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

    GET /retention_policies/{retention_policy_id}/assignments

  • Read

    Get retention policy assignment

    Retrieves a retention policy assignment.

    GET /retention_policy_assignments/{retention_policy_assignment_id}

  • Read

    Get files under retention

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

    GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention

  • Read

    Get file versions under retention

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

    GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention

  • Write

    Assign retention policy

    Assigns a retention policy to an item.

    POST /retention_policy_assignments

  • Destructive

    Remove retention policy assignment

    Removes a retention policy assignment applied to content.

    DELETE /retention_policy_assignments/{retention_policy_assignment_id}

Legal hold policies

  • Write

    Create legal hold policy

    Create a new legal hold policy.

    POST /legal_hold_policies

Legal hold policy assignments

  • Write

    Assign legal hold policy

    Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.

    POST /legal_hold_policy_assignments

File version retentions

  • Read

    List file version retentions

    Retrieves all file version retentions for the given enterprise. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

    GET /file_version_retentions

  • Read

    Get retention on file

    Returns information about a file version retention. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

    GET /file_version_retentions/{file_version_retention_id}

File version legal holds

Shield information barriers

  • Read

    Get shield information barrier with specified ID

    Get shield information barrier based on provided ID.

    GET /shield_information_barriers/{shield_information_barrier_id}

  • Read

    List shield information barriers

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

    GET /shield_information_barriers

  • Write

    Add changed status of shield information barrier with specified ID

    Change status of shield information barrier with the specified ID.

    POST /shield_information_barriers/change_status

  • Write

    Create shield information barrier

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

    POST /shield_information_barriers

Shield information barrier reports

  • Read

    List shield information barrier reports

    Lists shield information barrier reports.

    GET /shield_information_barrier_reports

  • Read

    Get shield information barrier report by ID

    Retrieves a shield information barrier report by its ID.

    GET /shield_information_barrier_reports/{shield_information_barrier_report_id}

  • Write

    Create shield information barrier report

    Creates a shield information barrier report for a given barrier.

    POST /shield_information_barrier_reports

Shield information barrier segments

  • Read

    Get shield information barrier segment with specified ID

    Retrieves shield information barrier segment based on provided ID..

    GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}

  • Read

    List shield information barrier segments

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

    GET /shield_information_barrier_segments

  • Write

    Create shield information barrier segment

    Creates a shield information barrier segment.

    POST /shield_information_barrier_segments

  • Destructive

    Delete shield information barrier segment

    Deletes the shield information barrier segment based on provided ID.

    DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}

  • Destructive

    Update shield information barrier segment with specified ID

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

    PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}

Shield information barrier segment members

  • Read

    Get shield information barrier segment member by ID

    Retrieves a shield information barrier segment member by its ID.

    GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}

  • Read

    List shield information barrier segment members

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

    GET /shield_information_barrier_segment_members

  • Write

    Create shield information barrier segment member

    Creates a new shield information barrier segment member.

    POST /shield_information_barrier_segment_members

  • Destructive

    Delete shield information barrier segment member by ID

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

    DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}

Shield information barrier segment restrictions

  • Read

    Get shield information barrier segment restriction by ID

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

    GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}

  • Read

    List shield information barrier segment restrictions

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

    GET /shield_information_barrier_segment_restrictions

  • Write

    Create shield information barrier segment restriction

    Creates a shield information barrier segment restriction object.

    POST /shield_information_barrier_segment_restrictions

  • Destructive

    Delete shield information barrier segment restriction by ID

    Delete shield information barrier segment restriction based on provided ID.

    DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}

Device pinners

  • Read

    Get device pin

    Retrieves information about an individual device pin.

    GET /device_pinners/{device_pinner_id}

  • Read

    List enterprise device pins

    Retrieves all the device pins within an enterprise. The user must have admin privileges, and the application needs the "manage enterprise" scope to make this call.

    GET /enterprises/{enterprise_id}/device_pinners

  • Destructive

    Remove device pin

    Deletes an individual device pin.

    DELETE /device_pinners/{device_pinner_id}

Terms of service

  • Read

    List terms of services

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

    GET /terms_of_services

  • Read

    Get terms of service

    Fetches a specific terms of service.

    GET /terms_of_services/{terms_of_service_id}

  • Write

    Create terms of service

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

    POST /terms_of_services

  • Destructive

    Update terms of service

    Updates a specific terms of service.

    PUT /terms_of_services/{terms_of_service_id}

Terms of service user statuses

  • Read

    List terms of service user statuses

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

    GET /terms_of_service_user_statuses

  • Write

    Create terms of service status for new user

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

    POST /terms_of_service_user_statuses

  • Destructive

    Update terms of service status for existing user

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

    PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}

Domain restrictions for collaborations

  • Read

    List allowed collaboration domains

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

    GET /collaboration_whitelist_entries

  • Read

    Get allowed collaboration domain

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

    GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}

  • Write

    Add domain to list of allowed collaboration domains

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

    POST /collaboration_whitelist_entries

  • Destructive

    Remove domain from list of allowed collaboration domains

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

    DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}

Domain restrictions (User exemptions)

  • Read

    List users exempt from collaboration domain restrictions

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

    GET /collaboration_whitelist_exempt_targets

  • Read

    Get user exempt from collaboration domain restrictions

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

    GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}

  • Write

    Create user exemption from collaboration domain restrictions

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

    POST /collaboration_whitelist_exempt_targets

  • Destructive

    Remove user from list of users exempt from domain restrictions

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

    DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}

Standard and Zones Storage Policies

  • Read

    List storage policies

    Fetches all the storage policies in the enterprise.

    GET /storage_policies

  • Read

    Get storage policy

    Fetches a specific storage policy.

    GET /storage_policies/{storage_policy_id}

Standard and Zones Storage Policy Assignments

  • Read

    List storage policy assignments

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

    GET /storage_policy_assignments

  • Read

    Get storage policy assignment

    Fetches a specific storage policy assignment.

    GET /storage_policy_assignments/{storage_policy_assignment_id}

  • Write

    Assign storage policy

    Creates a storage policy assignment for an enterprise or user.

    POST /storage_policy_assignments

  • Destructive

    Update storage policy assignment

    Updates a specific storage policy assignment.

    PUT /storage_policy_assignments/{storage_policy_assignment_id}

  • Destructive

    Unassign storage policy

    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.

    DELETE /storage_policy_assignments/{storage_policy_assignment_id}

Zip Downloads

  • Read

    Download zip archive

    Returns the contents of a `zip` archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device. By default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created. The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `download_url` field in the response to this endpoint.

    GET /zip_downloads/{zip_download_id}/content

  • Read

    Get zip download status

    Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped. This endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download. The URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](https://developer.box.com/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `status_url` field in the response to this endpoint.

    GET /zip_downloads/{zip_download_id}/status

  • Write

    Create zip download

    Creates a request to download multiple files and folders as a single `zip` archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download_url` and a `status_url` that can be used to download the archive. The limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first. **Note**: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.

    POST /zip_downloads

Box Sign requests

  • Read

    Get Box Sign request by ID

    Gets a sign request by ID.

    GET /sign_requests/{sign_request_id}

  • Read

    List Box Sign requests

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

    GET /sign_requests

  • Write

    Resend Box Sign request

    Resends a signature request email to all outstanding signers.

    POST /sign_requests/{sign_request_id}/resend

  • Write

    Create Box Sign request

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

    POST /sign_requests

  • Destructive

    Cancel Box Sign request

    Cancels a sign request.

    POST /sign_requests/{sign_request_id}/cancel

Workflows

  • Read

    List workflows

    Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in to use this endpoint.

    GET /workflows

  • Write

    Starts workflow based on request body

    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.

    POST /workflows/{workflow_id}/start

Box Sign templates

  • Read

    List Box Sign templates

    Gets Box Sign templates created by a user.

    GET /sign_templates

  • Read

    Get Box Sign template by ID

    Fetches details of a specific Box Sign template.

    GET /sign_templates/{template_id}

Integration mappings

  • Read

    List Slack integration mappings

    Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.

    GET /integration_mappings/slack

  • Read

    List Teams integration mappings

    Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.

    GET /integration_mappings/teams

  • Write

    Create Slack integration mapping

    Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item. You need Admin or Co-Admin role to use this endpoint.

    POST /integration_mappings/slack

  • Write

    Create Teams integration mapping

    Creates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.

    POST /integration_mappings/teams

  • Destructive

    Update Slack integration mapping

    Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.

    PUT /integration_mappings/slack/{integration_mapping_id}

  • Destructive

    Delete Slack integration mapping

    Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). You need Admin or Co-Admin role to use this endpoint.

    DELETE /integration_mappings/slack/{integration_mapping_id}

  • Destructive

    Update Teams integration mapping

    Updates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams). Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.

    PUT /integration_mappings/teams/{integration_mapping_id}

  • Destructive

    Delete Teams integration mapping

    Deletes a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams). You need Admin or Co-Admin role to use this endpoint.

    DELETE /integration_mappings/teams/{integration_mapping_id}

AI

  • Read

    Get AI agent default configuration

    Get the AI agent default config.

    GET /ai_agent_default

  • Write

    Ask question

    Sends 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 about a single file, several files, or the entire contents of a Box Hub. To search across and ask questions about everything in a Box Hub, send a single item with `type` set to `hubs` and the Hub's ID as the `id`. Box AI answers the question using the indexed content of all files in that Hub. Asking questions about a Box Hub requires Box AI for Hubs to be enabled in the Admin Console before the Hub is created, so that its content is indexed.

    POST /ai/ask

  • Write

    Generate text

    Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.

    POST /ai/text_gen

  • Write

    Extract metadata (freeform)

    Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. In this request, both the prompt and the output can be freeform. Metadata template setup before sending the request is not required.

    POST /ai/extract

  • Write

    Extract metadata (structured)

    Sends 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, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates) or use the [metadata template API](https://developer.box.com/guides/metadata/templates/create). This endpoint also supports [Enhanced Extract Agent](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent). For information about supported file formats and languages, see the [Extract metadata from file (structured)](https://developer.box.com/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.

    POST /ai/extract_structured

AI Studio

  • Read

    List AI agents

    Lists AI agents based on the provided parameters.

    GET /ai_agents

  • Read

    Get AI agent by agent ID

    Gets an AI Agent using the `agent_id` parameter.

    GET /ai_agents/{agent_id}

  • Write

    Create AI agent

    Creates an AI agent. At least one of the following capabilities must be provided: `ask`, `text_gen`, `extract`.

    POST /ai_agents

  • Destructive

    Update AI agent

    Updates an AI agent.

    PUT /ai_agents/{agent_id}

  • Destructive

    Delete AI agent

    Deletes an AI agent using the provided parameters.

    DELETE /ai_agents/{agent_id}

Metadata taxonomies

  • Read

    Get metadata taxonomies for namespace

    Used to retrieve all metadata taxonomies in a namespace.

    GET /metadata_taxonomies/{namespace}

  • Read

    Get metadata taxonomy by taxonomy key

    Used to retrieve a metadata taxonomy by taxonomy key.

    GET /metadata_taxonomies/{namespace}/{taxonomy_key}

  • Read

    List metadata taxonomy nodes

    Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

    GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes

  • Read

    Get metadata taxonomy node by ID

    Retrieves a metadata taxonomy node by its identifier.

    GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}

  • Read

    List metadata template's options for taxonomy field

    Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.

    GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options

  • Write

    Create metadata taxonomy

    Creates a new metadata taxonomy that can be used in metadata templates.

    POST /metadata_taxonomies

  • Write

    Update metadata taxonomy

    Updates an existing metadata taxonomy.

    PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}

  • Write

    Create metadata taxonomy levels

    Creates new metadata taxonomy levels.

    POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels

  • Write

    Update metadata taxonomy level

    Updates an existing metadata taxonomy level.

    PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}

  • Write

    Add metadata taxonomy level

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

    POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append

  • Write

    Create metadata taxonomy node

    Creates a new metadata taxonomy node.

    POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes

  • Write

    Update metadata taxonomy node

    Updates an existing metadata taxonomy node.

    PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}

  • Destructive

    Remove metadata taxonomy

    Delete a metadata taxonomy. This deletion is permanent and cannot be reverted.

    DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}

  • Destructive

    Delete metadata taxonomy level

    Deletes the last level of the metadata taxonomy.

    POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim

  • Destructive

    Remove metadata taxonomy node

    Delete a metadata taxonomy node. This deletion is permanent and cannot be reverted. Only metadata taxonomy nodes without any children can be deleted.

    DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}

docgen_template

  • Read

    List Box Doc Gen templates

    Lists Box Doc Gen templates on which the user is a collaborator.

    GET /docgen_templates

  • Read

    Get Box Doc Gen template by ID

    Lists details of a specific Box Doc Gen template.

    GET /docgen_templates/{template_id}

  • Read

    List all Box Doc Gen template tags in template

    Lists all tags in a Box Doc Gen template.

    GET /docgen_templates/{template_id}/tags

  • Read

    Get list of all Box Doc Gen jobs for template

    Lists the users jobs which use this template.

    GET /docgen_template_jobs/{template_id}

  • Write

    Create Box Doc Gen template

    Marks a file as a Box Doc Gen template.

    POST /docgen_templates

  • Destructive

    Delete Box Doc Gen template

    Unmarks file as Box Doc Gen template.

    DELETE /docgen_templates/{template_id}

docgen

  • Read

    Get Box Doc Gen job by ID

    Get details of the Box Doc Gen job.

    GET /docgen_jobs/{job_id}

  • Read

    List all Box Doc Gen jobs

    Lists all Box Doc Gen jobs for a user.

    GET /docgen_jobs

  • Read

    Get Box Doc Gen jobs by batch ID

    Lists Box Doc Gen jobs in a batch.

    GET /docgen_batch_jobs/{batch_id}

  • Write

    Generate document using Box Doc Gen template

    Generates a document using a Box Doc Gen template.

    POST /docgen_batches

enterprise_configurations

  • Read

    Get enterprise configuration

    Retrieves the configuration for an enterprise.

    GET /enterprise_configurations/{enterprise_id}

hubs

  • Read

    List all Box Hubs

    Retrieves all Box Hubs for requesting user.

    GET /hubs

  • Read

    List all Box Hubs for requesting enterprise

    Retrieves all Box Hubs for a given enterprise. Admins or Hub Co-admins of an enterprise with GCM scope can make this call.

    GET /enterprise_hubs

  • Read

    Get Box Hub information by ID

    Retrieves details for a Box Hub by its ID.

    GET /hubs/{hub_id}

  • Write

    Create Box Hub

    Creates a new Box Hub.

    POST /hubs

  • Write

    Update Box Hub information by ID

    Updates a Box Hub. Can be used to change title, description, or Box Hub settings.

    PUT /hubs/{hub_id}

  • Write

    Copy Box Hub

    Creates a copy of a Box Hub. The original Box Hub will not be modified.

    POST /hubs/{hub_id}/copy

  • Destructive

    Delete Box Hub

    Deletes a single Box Hub.

    DELETE /hubs/{hub_id}

hub_collaborations

  • Read

    Get Box Hub collaborations

    Retrieves all collaborations for a Box Hub.

    GET /hub_collaborations

  • Read

    Get Box Hub collaboration by collaboration ID

    Retrieves details for a Box Hub collaboration by collaboration ID.

    GET /hub_collaborations/{hub_collaboration_id}

  • Write

    Create Box Hub collaboration

    Adds a collaboration for a single user or a single group to a Box Hub. Collaborations can be created using email address, user IDs, or group IDs.

    POST /hub_collaborations

  • Write

    Update Box Hub collaboration

    Updates a Box Hub collaboration. Can be used to change the Box Hub role.

    PUT /hub_collaborations/{hub_collaboration_id}

  • Destructive

    Remove Box Hub collaboration

    Deletes a single Box Hub collaboration.

    DELETE /hub_collaborations/{hub_collaboration_id}

hub_items

  • Read

    Get Box Hub items

    Retrieves all items associated with a Box Hub.

    GET /hub_items

  • Destructive

    Manage Box Hub items

    Adds and/or removes Box Hub items from a Box Hub.

    POST /hubs/{hub_id}/manage_items

hub_document

  • Read

    List Hub Document Pages

    Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages.

    GET /hub_document_pages

  • Read

    List Hub Document blocks for page

    Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items. Blocks are hierarchically organized by their `parent_id`. Blocks are sorted in order based on user specification in the user interface. The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks.

    GET /hub_document_blocks

shield_lists

  • Read

    Get all shield lists in enterprise

    Retrieves all shield lists in the enterprise.

    GET /shield_lists

  • Read

    Get single shield list by shield list id

    Retrieves a single shield list by its ID.

    GET /shield_lists/{shield_list_id}

  • Write

    Create shield list

    Creates a shield list.

    POST /shield_lists

  • Write

    Update shield list

    Updates a shield list.

    PUT /shield_lists/{shield_list_id}

  • Destructive

    Delete single shield list by shield list id

    Delete a single shield list by its ID.

    DELETE /shield_lists/{shield_list_id}

archives

  • Read

    List archives

    Retrieves archives for an enterprise. To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

    GET /archives

  • Write

    Create archive

    Creates an archive. To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

    POST /archives

  • Write

    Update archive

    Updates an archive. To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives).

    PUT /archives/{archive_id}

  • Destructive

    Delete archive

    Permanently deletes an archive. To learn more about the archive APIs, see the [Archive API Guide](https://developer.box.com/guides/archives). This endpoint is currently unavailable. Please contact support for assistance.

    DELETE /archives/{archive_id}

external_users

  • Destructive

    Submit job to delete external users

    Delete external users from current user enterprise. This will remove each external user from all invited collaborations within the current enterprise.

    POST /external_users/submit_delete_job

automate_workflows

  • Read

    List Automate workflows defined as callable actions

    Returns workflow actions from Automate for a folder, using the `WORKFLOW` action category.

    GET /automate_workflows

  • Write

    Start Automate workflow

    Starts an Automate workflow manually by using a workflow action ID and file IDs.

    POST /automate_workflows/{workflow_id}/start

notes

  • Write

    Convert content to Box Note

    Creates a Box Note (`.boxnote` file) from supported source content. See the `content_format` field for supported formats.

    POST /notes/convert

document_split

  • Read

    List Document Split jobs

    Returns a paginated list of Document Split jobs accessible to the authenticated user.

    GET /document_splits

  • Read

    Get Document Split job by ID

    Returns details for a single Document Split job identified by its ID, including the current status, the input definition, and any output files produced by the job.

    GET /document_splits/{document_split_id}

  • Write

    Create Document Split job

    Initiates a Document Split job for the supplied source file. The job runs asynchronously; clients can poll the returned job ID to track progress. All split-specific input lives under `split_input`. When `split_input.split_type` is `manual`, provide `split_input.split_definition` (continuous page ranges; `version` may be omitted or `v_1`). When `split_input.split_type` is `page_selection`, provide `split_input.page_selection` (non-linear page segments; `version` may be omitted or `v_2`). `split_input.prompt` must not be provided for either of those variants. When `split_input.split_type` is `smart`, `split_input.prompt` is required and neither `split_input.split_definition` nor `split_input.page_selection` must be provided.

    POST /document_splits

query

  • Read

    Box Query

    Runs a query to discover Box items using a logical predicate, similar to a SQL WHERE clause. The predicate can filter across multiple metadata templates and item fields in a single request. Results can be sorted, paginated with markers, and shaped with fields so each entry includes additional item or metadata attributes. This is the item-retrieval endpoint in the Query API (version 2026.0). Unlike the [Metadata Query API](https://developer.box.com/reference/post-metadata-queries-execute-read), it is not limited to a single metadata template or to files and folders. For totals and grouped metrics over the same predicates, use [Query Insights](https://developer.box.com/reference/v2026.0/post-query-insights) instead of paging through every matching item. For predicate syntax, parameters, examples, pagination behavior, and error codes, see the [Box Query guide](https://developer.box.com/guides/query/box-query). For shared response schemas, including Query results and result entries, see [Query resources](https://developer.box.com/reference/v2026.0/query-resources).

    POST /query

  • Read

    Create insights for Box items

    Computes aggregated metrics over Box items matching a query predicate. Filters are applied first, followed by optional grouping, after which the requested metrics (such as `sum`, `avg`, `min`, `max`, and `count`) are computed for each resulting group or over the entire filtered dataset.

    POST /query_insights

shuttle

  • Read

    List shuttle systems

    Returns a paginated list of shuttle systems accessible to the authenticated user.

    GET /shuttle_systems

  • Read

    Get shuttle system by ID

    Returns details for a single shuttle system identified by its ID, including its type and connection state.

    GET /shuttle_systems/{shuttle_system_id}

  • Read

    List shuttle jobs

    Returns a paginated list of shuttle jobs accessible to the authenticated user.

    GET /shuttle_jobs

  • Read

    Get shuttle job by ID

    Returns details for a single shuttle job identified by its ID, including its current state, mapping-preparation state, and configured source system.

    GET /shuttle_jobs/{shuttle_job_id}

  • Read

    List shuttle runs

    Returns a paginated list of runs for the shuttle job identified by `job_id`.

    GET /shuttle_runs

  • Read

    Get shuttle run by ID

    Returns details for a single shuttle run identified by its ID, including its mode, state, timing, and transfer statistics.

    GET /shuttle_runs/{shuttle_run_id}

  • Read

    List shuttle job schedules

    Returns a paginated list of schedules for the shuttle job identified by `job_id`.

    GET /shuttle_job_schedules

  • Read

    Get shuttle job schedule

    Retrieves the shuttle job schedule identified by its ID.

    GET /shuttle_job_schedules/{shuttle_job_schedule_id}

  • Read

    List shuttle path mappings

    Returns a paginated list of path mappings for the shuttle job identified by `job_id`.

    GET /shuttle_path_mappings

  • Read

    Get shuttle path mapping by ID

    Returns details for a single shuttle path mapping identified by its ID, including the source location and destination, if any.

    GET /shuttle_path_mappings/{shuttle_path_mapping_id}

  • Read

    List shuttle subject mappings

    Returns a paginated list of subject mappings for the shuttle job identified by `job_id`.

    GET /shuttle_subject_mappings

  • Read

    Get shuttle subject mapping by ID

    Returns details for a single shuttle subject mapping identified by its ID, including the source subject and Box target, if any.

    GET /shuttle_subject_mappings/{shuttle_subject_mapping_id}

  • Read

    List shuttle discovered subjects

    Returns a paginated list of subjects discovered on the source system for the shuttle job identified by `job_id`.

    GET /shuttle_discovered_subjects

  • Read

    List shuttle path entries

    Returns a paginated list of source or target path entries for a shuttle job. Call with only `job_id` and `side` to list the roots, then browse one level at a time using `path`, `path_id`, or both. Each entry includes `path`, `path_id`, `is_directory`, and a `scope` object (`account` or `shared_space`) so a mapping can be created from that row without extra browse state. Valid values depend on the selected system.

    GET /shuttle_path_entries

  • Read

    List shuttle mapping errors

    Returns a paginated list of mapping errors for a shuttle job. Only the latest record for each error is returned. The revision field identifies the mapping revision in which that error was generated.

    GET /shuttle_mapping_errors

  • Read

    List shuttle reports

    Returns a paginated list of reports generated for the shuttle run identified by `run_id`.

    GET /shuttle_reports

  • Read

    Get shuttle report by ID

    Returns details for a single shuttle report identified by its ID, including generation status and, once generation finishes, the Box output reference.

    GET /shuttle_reports/{shuttle_report_id}

  • Write

    Create shuttle system

    Creates a new shuttle system. Only Windows agent systems can be created through the public API; other system types must be configured through the Shuttle application.

    POST /shuttle_systems

  • Write

    Update shuttle system

    Updates the mutable properties of an existing shuttle system identified by its ID. Only the fields supplied in the request body are changed.

    PUT /shuttle_systems/{shuttle_system_id}

  • Write

    Issue registration token for Windows system

    Issues a new installation token for the Windows shuttle system identified by its ID. Paste the returned token into the Windows agent installer to register the agent with this system.

    POST /shuttle_systems/{shuttle_system_id}/issue_registration_token

  • Write

    Create shuttle job

    Creates a new shuttle job that describes a migration from the given source system into Box.

    POST /shuttle_jobs

  • Write

    Update shuttle job

    Updates the mutable properties of an existing shuttle job identified by its ID. Only the fields supplied in the request body are changed.

    PUT /shuttle_jobs/{shuttle_job_id}

  • Write

    Prepare migration

    Validates the configured account and path mappings before a transfer. Only relevant when account mapping is enabled.

    POST /shuttle_jobs/{shuttle_job_id}/prepare_migration

  • Write

    Create shuttle job schedule

    Creates a schedule that starts runs of the shuttle job identified by `job_id`. The schedule starts a run either at a wall-clock time or after another job's run meets a condition. Schedules cannot start a run in `scan` mode.

    POST /shuttle_job_schedules

  • Write

    Create shuttle path mapping

    Creates a path mapping that connects a source location on the migrated system to a destination in Box for the given shuttle job.

    POST /shuttle_path_mappings

  • Write

    Create shuttle subject mapping

    Creates a subject mapping that connects a discovered source subject to a Box user or group for the given shuttle job.

    POST /shuttle_subject_mappings

  • Write

    Update shuttle subject mapping

    Updates the mutable properties of an existing shuttle subject mapping identified by its ID. Only the fields supplied in the request body are changed.

    PUT /shuttle_subject_mappings/{shuttle_subject_mapping_id}

  • Write

    Create shuttle report

    Requests asynchronous generation of a report for a shuttle run. The report is returned immediately in `pending` or `processing` status. Poll `GET /shuttle_reports/{shuttle_report_id}` while `status` is `pending` or `processing`. Stop when `status` is `complete`, `failed`, `canceled`, or `unknown`. Repeating this request with the same parameters reuses the existing report instead of creating a duplicate.

    POST /shuttle_reports

  • Destructive

    Delete shuttle system

    Permanently deletes the shuttle system identified by its ID. This does not affect content that has already been migrated.

    DELETE /shuttle_systems/{shuttle_system_id}

  • Destructive

    Delete shuttle job

    Permanently deletes the shuttle job identified by its ID. This does not affect content that has already been migrated.

    DELETE /shuttle_jobs/{shuttle_job_id}

  • Destructive

    Start shuttle job

    Starts the job in the given mode. When no body is provided the job runs in simulation mode.

    POST /shuttle_jobs/{shuttle_job_id}/start

  • Destructive

    Stop shuttle job

    Stops a running shuttle job identified by its ID. Any work already in progress is allowed to finish before the job transitions to a stopped state.

    POST /shuttle_jobs/{shuttle_job_id}/stop

  • Destructive

    Update shuttle job schedule

    Updates the mutable properties of an existing shuttle job schedule identified by its ID. Only the fields supplied in the request body are changed. The owning job cannot be changed.

    PUT /shuttle_job_schedules/{shuttle_job_schedule_id}

  • Destructive

    Delete shuttle job schedule

    Permanently deletes the shuttle job schedule identified by its ID. This does not affect runs that have already started.

    DELETE /shuttle_job_schedules/{shuttle_job_schedule_id}

  • Destructive

    Update shuttle path mapping

    Updates the mutable properties of an existing shuttle path mapping identified by its ID. Only the fields supplied in the request body are changed.

    PUT /shuttle_path_mappings/{shuttle_path_mapping_id}

  • Destructive

    Delete shuttle path mapping

    Permanently deletes the shuttle path mapping identified by its ID. This does not affect content that has already been migrated.

    DELETE /shuttle_path_mappings/{shuttle_path_mapping_id}

  • Destructive

    Create shuttle path mapping import

    Accepts a spreadsheet of path mappings, already stored in Box, and replaces the job's path mappings. A file that is not a mapping workbook, or that exceeds the size or row limits (10 MiB Box download limit; 100,000 mapping rows), returns `400` synchronously and leaves the job unchanged. An accepted import always replaces every path mapping on the job. When all rows are valid the workbook is deployed in full. When any row is invalid the job ends with no path mappings and `mapping_state` becomes `paths_import_rejected` until the next import or the next manual path-mapping change. Row problems are listed by `GET /shuttle_mapping_errors?job_id=…` with category `path_import`, messages of the form `Row N: …`, at most 500 entries plus one overflow entry. Validation and deployment are asynchronous after acceptance. Poll `GET /shuttle_jobs/{shuttle_job_id}` while `mapping_state` is `importing_paths`. Only one import may be in flight per job.

    POST /shuttle_path_mapping_imports

  • Destructive

    Create shuttle subject mapping import

    Accepts a spreadsheet of subject (user and group) mappings, already stored in Box, and replaces the job's subject mappings. A file that is not a subject-mapping workbook, or that exceeds the size or row limits (10 MiB Box download limit; 50,000 mapping rows), returns `400` synchronously and leaves the job unchanged. An accepted import always replaces every subject mapping on the job. When all rows are valid the workbook is deployed in full. When any row is invalid the job ends with no subject mappings and `mapping_state` becomes `subjects_import_rejected` until the next import or the next manual subject-mapping change. Row problems are listed by `GET /shuttle_mapping_errors?job_id=…` with category `subject_import`, messages of the form `Row N: …`, at most 500 entries plus one overflow entry. Validation and deployment are asynchronous after acceptance. Poll `GET /shuttle_jobs/{shuttle_job_id}` while `mapping_state` is `importing_subjects`. Only one import may be in flight per job. The job must map subjects (`account_mapping` enabled) and its source scan must be finished; otherwise the request returns `409`. Expected workbook format (API clients cannot download the UI template): sheets `Users` and/or `Groups` (a sheet named `Subjects` is also accepted). Columns are `Source User `, `Target User `, `Skip` on `Users`, and `Source Group `, `Target Group `, `Skip` on `Groups`, where `` is the primary identifier for that role and system: - Users: `Email` for most systems; `ID` for `SharePoint` (2007/2010/2013); `Name` for Windows (`windows_union`, stored as the user id). - Groups: `Name` for most systems; `Email` for Google Drive admin groups. Source rows for a template can be taken from `GET /shuttle_discovered_subjects`.

    POST /shuttle_subject_mapping_imports

  • Destructive

    Delete shuttle subject mapping

    Permanently deletes the shuttle subject mapping identified by its ID.

    DELETE /shuttle_subject_mappings/{shuttle_subject_mapping_id}

Get started

  1. Open Space settings → Connections and search for Box.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.

Reference date: October 29, 2026. Box API docs.