Box

Box MCP Server for Cloudflare Workers

Available Tools

127 tools available in the Box MCP server. Each tool can be called by AI assistants to perform specific actions.

box_list_collections

List all collections (e.g., Favorites) for the current user.

Args:

format: Response format ('json' or 'markdown')

Returns: List of collections.

{
  "type": "object",
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

box_permanently_delete_file

Permanently delete a file from trash. This cannot be undone.

Args:

fileId: The ID of the file to permanently delete

Returns: Confirmation of permanent deletion.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file to permanently delete"
    }
  }
}

box_delete_file_request

Delete a file request.

Args:

fileRequestId: The ID of the file request to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "fileRequestId"
  ],
  "properties": {
    "fileRequestId": {
      "type": "string",
      "description": "The ID of the file request to delete"
    }
  }
}

box_delete_collaboration

Remove a collaboration (unshare).

Args:

collaborationId: The ID of the collaboration to remove

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "collaborationId"
  ],
  "properties": {
    "collaborationId": {
      "type": "string",
      "description": "The ID of the collaboration to remove"
    }
  }
}

box_get_file_request

Get details about a file request.

Args:

fileRequestId: The ID of the file request
format: Response format ('json' or 'markdown')

Returns: File request details.

{
  "type": "object",
  "required": [
    "fileRequestId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "fileRequestId": {
      "type": "string",
      "description": "The ID of the file request"
    }
  }
}

box_copy_file_request

Copy a file request to a new folder.

Args:

fileRequestId: The ID of the file request to copy
folderId: The destination folder ID

Returns: The copied file request.

{
  "type": "object",
  "required": [
    "fileRequestId",
    "folderId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The destination folder ID"
    },
    "fileRequestId": {
      "type": "string",
      "description": "The ID of the file request to copy"
    }
  }
}

box_list_folder_metadata

List all metadata instances on a folder.

Args:

folderId: The ID of the folder
format: Response format ('json' or 'markdown')

Returns: List of metadata instances on the folder.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    }
  }
}

box_update_file_request

Update a file request.

Args:

fileRequestId: The ID of the file request to update
title: New title
description: New description
status: New status ('active' or 'inactive')
isEmailRequired: Whether email is required
isDescriptionRequired: Whether description is required
expiresAt: Expiration date (ISO 8601)

Returns: The updated file request.

{
  "type": "object",
  "required": [
    "fileRequestId"
  ],
  "properties": {
    "title": {
      "type": "string",
      "description": "New title"
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "description": "New status"
    },
    "expiresAt": {
      "type": "string",
      "description": "Expiration date (ISO 8601)"
    },
    "description": {
      "type": "string",
      "description": "New description"
    },
    "fileRequestId": {
      "type": "string",
      "description": "The ID of the file request"
    },
    "isEmailRequired": {
      "type": "boolean",
      "description": "Whether email is required"
    },
    "isDescriptionRequired": {
      "type": "boolean",
      "description": "Whether description is required"
    }
  }
}

box_list_legal_hold_policies

List all legal hold policies.

Args:

limit: Maximum number of policies to return
marker: Pagination marker
policyName: Filter by policy name
format: Response format ('json' or 'markdown')

Returns: List of legal hold policies.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    },
    "policyName": {
      "type": "string",
      "description": "Filter by policy name"
    }
  }
}

box_get_legal_hold_policy

Get details about a legal hold policy.

Args:

policyId: The ID of the policy
format: Response format ('json' or 'markdown')

Returns: Legal hold policy details.

{
  "type": "object",
  "required": [
    "policyId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "policyId": {
      "type": "string",
      "description": "The ID of the policy"
    }
  }
}

box_create_legal_hold_policy

Create a legal hold policy.

Args:

policyName: Name for the policy
description: Description of the policy
filterStartedAt: Start date filter (ISO 8601)
filterEndedAt: End date filter (ISO 8601)
isOngoing: Whether the hold is ongoing

Returns: The created legal hold policy.

{
  "type": "object",
  "required": [
    "policyName"
  ],
  "properties": {
    "isOngoing": {
      "type": "boolean",
      "description": "Whether the hold is ongoing"
    },
    "policyName": {
      "type": "string",
      "description": "Name for the policy"
    },
    "description": {
      "type": "string",
      "description": "Description of the policy"
    },
    "filterEndedAt": {
      "type": "string",
      "description": "End date filter (ISO 8601)"
    },
    "filterStartedAt": {
      "type": "string",
      "description": "Start date filter (ISO 8601)"
    }
  }
}

box_delete_legal_hold_policy

Delete a legal hold policy.

Args:

policyId: The ID of the policy to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "policyId"
  ],
  "properties": {
    "policyId": {
      "type": "string",
      "description": "The ID of the policy to delete"
    }
  }
}

box_list_retention_policies

List all retention policies.

Args:

limit: Maximum number of policies to return
marker: Pagination marker
policyName: Filter by policy name
policyType: Filter by policy type ('finite' or 'indefinite')
format: Response format ('json' or 'markdown')

Returns: List of retention policies.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    },
    "policyName": {
      "type": "string",
      "description": "Filter by policy name"
    },
    "policyType": {
      "enum": [
        "finite",
        "indefinite"
      ],
      "type": "string",
      "description": "Filter by policy type"
    }
  }
}

box_get_retention_policy

Get details about a retention policy.

Args:

policyId: The ID of the policy
format: Response format ('json' or 'markdown')

Returns: Retention policy details.

{
  "type": "object",
  "required": [
    "policyId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "policyId": {
      "type": "string",
      "description": "The ID of the policy"
    }
  }
}

box_list_sign_requests

List all Box Sign requests.

Args:

limit: Maximum number of requests to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of sign requests.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_get_sign_request

Get details about a Box Sign request.

Args:

signRequestId: The ID of the sign request
format: Response format ('json' or 'markdown')

Returns: Sign request details.

{
  "type": "object",
  "required": [
    "signRequestId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "signRequestId": {
      "type": "string",
      "description": "The ID of the sign request"
    }
  }
}

box_get_pending_collaborations

Get all pending collaboration invitations for the current user.

Args:

limit: Maximum number of collaborations to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: List of pending collaboration invitations.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    }
  }
}

box_create_sign_request

Create a Box Sign request.

Args:

sourceFileIds: Comma-separated list of file IDs to sign
signerEmails: Comma-separated list of signer email addresses
parentFolderId: Folder ID to store signed documents
emailSubject: Subject line for the sign request email
emailMessage: Message body for the sign request email
name: Name for the sign request
daysValid: Number of days the request is valid

Returns: The created sign request.

{
  "type": "object",
  "required": [
    "sourceFileIds",
    "signerEmails",
    "parentFolderId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Name for the request"
    },
    "daysValid": {
      "type": "integer",
      "description": "Days the request is valid"
    },
    "emailMessage": {
      "type": "string",
      "description": "Email message"
    },
    "emailSubject": {
      "type": "string",
      "description": "Email subject"
    },
    "signerEmails": {
      "type": "string",
      "description": "Comma-separated list of signer emails"
    },
    "sourceFileIds": {
      "type": "string",
      "description": "Comma-separated list of file IDs"
    },
    "parentFolderId": {
      "type": "string",
      "description": "Folder ID for signed documents"
    }
  }
}

box_cancel_sign_request

Cancel a Box Sign request.

Args:

signRequestId: The ID of the sign request to cancel

Returns: The cancelled sign request.

{
  "type": "object",
  "required": [
    "signRequestId"
  ],
  "properties": {
    "signRequestId": {
      "type": "string",
      "description": "The ID of the sign request to cancel"
    }
  }
}

box_resend_sign_request

Resend a Box Sign request to signers.

Args:

signRequestId: The ID of the sign request to resend

Returns: Confirmation of resend.

{
  "type": "object",
  "required": [
    "signRequestId"
  ],
  "properties": {
    "signRequestId": {
      "type": "string",
      "description": "The ID of the sign request to resend"
    }
  }
}

box_list_sign_templates

List all Box Sign templates.

Args:

limit: Maximum number of templates to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of sign templates.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_get_sign_template

Get details about a Box Sign template.

Args:

templateId: The ID of the sign template
format: Response format ('json' or 'markdown')

Returns: Sign template details.

{
  "type": "object",
  "required": [
    "templateId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "templateId": {
      "type": "string",
      "description": "The ID of the sign template"
    }
  }
}

box_create_zip_download

Create a zip download for multiple files and folders.

Args:

items: JSON array of items to include: [{"type": "file", "id": "123"}, {"type": "folder", "id": "456"}]
downloadFileName: Optional name for the zip file

Returns: Download URL and status URL.

{
  "type": "object",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "string",
      "description": "JSON array of items to include"
    },
    "downloadFileName": {
      "type": "string",
      "description": "Name for the zip file"
    }
  }
}

box_get_collaboration

Get details about a specific collaboration.

Args:

collaborationId: The ID of the collaboration
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Collaboration details including role, status, and participants.

{
  "type": "object",
  "required": [
    "collaborationId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "collaborationId": {
      "type": "string",
      "description": "The ID of the collaboration"
    }
  }
}

box_create_collaboration

Add a collaboration (share) on a file or folder.

Args:

itemId: The ID of the file or folder to share
itemType: Type of item ('file' or 'folder')
accessibleByType: Type of collaborator ('user' or 'group')
accessibleById: ID of the user or group (optional if using login)
accessibleByLogin: Email of the user to invite (optional if using id)
role: Role for the collaboration (editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner)
canViewPath: Allow collaborator to view path to item
expiresAt: When the collaboration expires (ISO 8601 format)
isAccessOnly: Whether collaboration is access-only

Returns: The created collaboration object.

Available roles:

editor: Can view, download, edit, upload, delete
viewer: Can view and download
previewer: Can only preview
uploader: Can only upload
previewer uploader: Can preview and upload
viewer uploader: Can view, download, and upload
co-owner: Full access except transferring ownership

{
  "type": "object",
  "required": [
    "itemId",
    "itemType",
    "accessibleByType",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "editor",
        "viewer",
        "previewer",
        "uploader",
        "previewer uploader",
        "viewer uploader",
        "co-owner"
      ],
      "type": "string",
      "description": "Role for the collaboration"
    },
    "itemId": {
      "type": "string",
      "description": "The ID of the file or folder to share"
    },
    "itemType": {
      "enum": [
        "file",
        "folder"
      ],
      "type": "string",
      "description": "Type of item"
    },
    "expiresAt": {
      "type": "string",
      "description": "When the collaboration expires (ISO 8601 format)"
    },
    "canViewPath": {
      "type": "boolean",
      "description": "Allow collaborator to view path to item"
    },
    "isAccessOnly": {
      "type": "boolean",
      "description": "Whether collaboration is access-only"
    },
    "accessibleById": {
      "type": "string",
      "description": "ID of the user or group"
    },
    "accessibleByType": {
      "enum": [
        "user",
        "group"
      ],
      "type": "string",
      "description": "Type of collaborator"
    },
    "accessibleByLogin": {
      "type": "string",
      "description": "Email of the user to invite"
    }
  }
}

box_update_collaboration

Update a collaboration's role or settings.

Args:

collaborationId: The ID of the collaboration to update
role: New role for the collaboration
canViewPath: Allow collaborator to view path to item
expiresAt: When the collaboration expires (ISO 8601 format)
status: Status of the collaboration ('accepted', 'pending', 'rejected')

Returns: The updated collaboration object.

{
  "type": "object",
  "required": [
    "collaborationId",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "editor",
        "viewer",
        "previewer",
        "uploader",
        "previewer uploader",
        "viewer uploader",
        "co-owner"
      ],
      "type": "string",
      "description": "New role"
    },
    "status": {
      "enum": [
        "accepted",
        "pending",
        "rejected"
      ],
      "type": "string",
      "description": "Status of the collaboration"
    },
    "expiresAt": {
      "type": "string",
      "description": "When the collaboration expires"
    },
    "canViewPath": {
      "type": "boolean",
      "description": "Allow collaborator to view path"
    },
    "collaborationId": {
      "type": "string",
      "description": "The ID of the collaboration to update"
    }
  }
}

box_get_collection_items

Get items in a collection.

Args:

collectionId: The ID of the collection
limit: Maximum number of items to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: Items (files, folders, web links) in the collection.

{
  "type": "object",
  "required": [
    "collectionId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "collectionId": {
      "type": "string",
      "description": "The ID of the collection"
    }
  }
}

box_add_file_to_collection

Add a file to a collection (e.g., mark as favorite).

Args:

fileId: The ID of the file
collectionId: The ID of the collection

Returns: The updated file.

{
  "type": "object",
  "required": [
    "fileId",
    "collectionId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "collectionId": {
      "type": "string",
      "description": "The ID of the collection"
    }
  }
}

box_remove_file_from_collection

Remove a file from a collection.

Args:

fileId: The ID of the file
collectionId: The ID of the collection

Returns: The updated file.

{
  "type": "object",
  "required": [
    "fileId",
    "collectionId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "collectionId": {
      "type": "string",
      "description": "The ID of the collection"
    }
  }
}

box_add_folder_to_collection

Add a folder to a collection (e.g., mark as favorite).

Args:

folderId: The ID of the folder
collectionId: The ID of the collection

Returns: The updated folder.

{
  "type": "object",
  "required": [
    "folderId",
    "collectionId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "collectionId": {
      "type": "string",
      "description": "The ID of the collection"
    }
  }
}

box_remove_folder_from_collection

Remove a folder from a collection.

Args:

folderId: The ID of the folder
collectionId: The ID of the collection

Returns: The updated folder.

{
  "type": "object",
  "required": [
    "folderId",
    "collectionId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "collectionId": {
      "type": "string",
      "description": "The ID of the collection"
    }
  }
}

box_get_comment

Get details about a specific comment.

Args:

commentId: The ID of the comment
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Comment details including message, author, and timestamps.

{
  "type": "object",
  "required": [
    "commentId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "commentId": {
      "type": "string",
      "description": "The ID of the comment"
    }
  }
}

box_create_comment

Add a comment to a file.

Args:

fileId: The ID of the file to comment on
message: The comment message
taggedMessage: Optional message with @mentions (format: @[user_id:user_name])

Returns: The created comment object.

To mention users in a comment, use the taggedMessage parameter with format: @[user_id:User Name] Review this section

{
  "type": "object",
  "required": [
    "fileId",
    "message"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file to comment on"
    },
    "message": {
      "type": "string",
      "description": "The comment message"
    },
    "taggedMessage": {
      "type": "string",
      "description": "Message with @mentions"
    }
  }
}

box_reply_to_comment

Reply to an existing comment.

Args:

commentId: The ID of the comment to reply to
message: The reply message
taggedMessage: Optional message with @mentions

Returns: The created reply comment.

{
  "type": "object",
  "required": [
    "commentId",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "The reply message"
    },
    "commentId": {
      "type": "string",
      "description": "The ID of the comment to reply to"
    },
    "taggedMessage": {
      "type": "string",
      "description": "Message with @mentions"
    }
  }
}

box_update_comment

Update an existing comment.

Args:

commentId: The ID of the comment to update
message: The new message

Returns: The updated comment object.

{
  "type": "object",
  "required": [
    "commentId",
    "message"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "The new message"
    },
    "commentId": {
      "type": "string",
      "description": "The ID of the comment to update"
    }
  }
}

box_delete_comment

Delete a comment.

Args:

commentId: The ID of the comment to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "commentId"
  ],
  "properties": {
    "commentId": {
      "type": "string",
      "description": "The ID of the comment to delete"
    }
  }
}

box_get_events

Get user or enterprise events.

Args:

streamType: Type of event stream
- 'all': All events (user)
- 'changes': Content changes only (user)
- 'sync': Sync events (user)
- 'admin_logs': Admin events (enterprise admin only)
- 'admin_logs_streaming': Admin events streaming (enterprise admin only)
streamPosition: Position marker to start from (use next_stream_position from previous call)
limit: Maximum number of events to return
eventTypes: Comma-separated list of event types to filter
createdAfter: Only return events after this date (ISO 8601)
createdBefore: Only return events before this date (ISO 8601)
format: Response format ('json' or 'markdown')

Returns: Events with next_stream_position for pagination.

Common event types:

ITEM_CREATE, ITEM_UPLOAD, ITEM_MOVE, ITEM_COPY, ITEM_TRASH, ITEM_UNDELETE_VIA_TRASH
ITEM_DOWNLOAD, ITEM_PREVIEW, ITEM_RENAME, ITEM_SHARED_CREATE, ITEM_SHARED_UPDATE
COLLABORATION_INVITE, COLLABORATION_ACCEPT, COLLABORATION_REMOVE
COMMENT_CREATE, TASK_CREATE, TASK_ASSIGNMENT_CREATE

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 500,
      "minimum": 1,
      "description": "Maximum number of events"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "eventTypes": {
      "type": "string",
      "description": "Comma-separated list of event types"
    },
    "streamType": {
      "enum": [
        "all",
        "changes",
        "sync",
        "admin_logs",
        "admin_logs_streaming"
      ],
      "type": "string",
      "default": "all",
      "description": "Type of event stream"
    },
    "createdAfter": {
      "type": "string",
      "description": "Only events after this date (ISO 8601)"
    },
    "createdBefore": {
      "type": "string",
      "description": "Only events before this date (ISO 8601)"
    },
    "streamPosition": {
      "type": "string",
      "description": "Position marker to start from"
    }
  }
}

box_get_recent_items

Get recently accessed items for the current user.

Args:

limit: Maximum number of items to return
marker: Pagination marker
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: List of recently accessed files, folders, and web links.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "fields": {
      "type": "string",
      "description": "Fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_get_file

Get detailed information about a file.

Args:

fileId: The ID of the file
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: File details including name, size, dates, owner, and more.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

box_download_file

Download the content of a file.

Args:

fileId: The ID of the file to download

Returns: The file content as base64 encoded string.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file to download"
    }
  }
}

box_upload_file

Upload a new file to a folder.

Args:

folderId: The ID of the parent folder (use "0" for root)
filename: The name for the uploaded file
content: The file content (text or base64 encoded)
isBase64: Whether the content is base64 encoded (default: false)

Returns: The created file object.

{
  "type": "object",
  "required": [
    "folderId",
    "filename",
    "content"
  ],
  "properties": {
    "content": {
      "type": "string",
      "description": "The file content (text or base64 encoded)"
    },
    "filename": {
      "type": "string",
      "description": "The name for the uploaded file"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the parent folder (use \"0\" for root)"
    },
    "isBase64": {
      "type": "boolean",
      "default": false,
      "description": "Whether the content is base64 encoded"
    }
  }
}

box_upload_file_version

Upload a new version of an existing file.

Args:

fileId: The ID of the file to update
content: The new file content (text or base64 encoded)
isBase64: Whether the content is base64 encoded (default: false)

Returns: The updated file object.

{
  "type": "object",
  "required": [
    "fileId",
    "content"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file to update"
    },
    "content": {
      "type": "string",
      "description": "The new file content (text or base64 encoded)"
    },
    "isBase64": {
      "type": "boolean",
      "default": false,
      "description": "Whether the content is base64 encoded"
    }
  }
}

box_update_file

Update file metadata (name, description, parent folder, tags).

Args:

fileId: The ID of the file to update
name: New name for the file
description: New description for the file
parentId: Move file to this folder ID
tags: Comma-separated list of tags

Returns: The updated file object.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "New name for the file"
    },
    "tags": {
      "type": "string",
      "description": "Comma-separated list of tags"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file to update"
    },
    "parentId": {
      "type": "string",
      "description": "Move file to this folder ID"
    },
    "description": {
      "type": "string",
      "description": "New description for the file"
    }
  }
}

box_copy_file

Copy a file to another folder.

Args:

fileId: The ID of the file to copy
parentId: The ID of the destination folder
name: Optional new name for the copied file

Returns: The copied file object.

{
  "type": "object",
  "required": [
    "fileId",
    "parentId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Optional new name for the copied file"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file to copy"
    },
    "parentId": {
      "type": "string",
      "description": "The ID of the destination folder"
    }
  }
}

box_delete_file

Delete a file (moves to trash).

Args:

fileId: The ID of the file to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file to delete"
    }
  }
}

box_get_file_versions

Get all versions of a file.

Args:

fileId: The ID of the file
limit: Maximum number of versions to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: List of file versions.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of versions to return"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    }
  }
}

box_promote_file_version

Promote an older version to be the current version.

Args:

fileId: The ID of the file
versionId: The ID of the version to promote

Returns: The promoted file version.

{
  "type": "object",
  "required": [
    "fileId",
    "versionId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "versionId": {
      "type": "string",
      "description": "The ID of the version to promote"
    }
  }
}

box_delete_file_version

Delete a specific version of a file.

Args:

fileId: The ID of the file
versionId: The ID of the version to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "fileId",
    "versionId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "versionId": {
      "type": "string",
      "description": "The ID of the version to delete"
    }
  }
}

box_get_file_thumbnail

Get a thumbnail image for a file.

Args:

fileId: The ID of the file
extension: Thumbnail format ('png' or 'jpg')
minHeight: Minimum height in pixels
minWidth: Minimum width in pixels

Returns: Thumbnail as base64 encoded string.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "minWidth": {
      "type": "integer",
      "minimum": 1,
      "description": "Minimum width in pixels"
    },
    "extension": {
      "enum": [
        "png",
        "jpg"
      ],
      "type": "string",
      "default": "png",
      "description": "Thumbnail format"
    },
    "minHeight": {
      "type": "integer",
      "minimum": 1,
      "description": "Minimum height in pixels"
    }
  }
}

box_get_file_comments

Get all comments on a file.

Args:

fileId: The ID of the file
limit: Maximum number of comments to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: List of comments on the file.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of comments to return"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    }
  }
}

box_get_file_tasks

Get all tasks on a file.

Args:

fileId: The ID of the file
format: Response format ('json' or 'markdown')

Returns: List of tasks on the file.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

box_get_file_collaborations

Get all collaborations on a file.

Args:

fileId: The ID of the file
limit: Maximum number of collaborations to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of collaborations on the file.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_get_trashed_file

Get information about a file in trash.

Args:

fileId: The ID of the trashed file
format: Response format ('json' or 'markdown')

Returns: The trashed file details.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the trashed file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

box_restore_file

Restore a file from trash.

Args:

fileId: The ID of the file to restore
name: Optional new name for the restored file
parentId: Optional folder ID to restore to

Returns: The restored file object.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Optional new name for the restored file"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file to restore"
    },
    "parentId": {
      "type": "string",
      "description": "Optional folder ID to restore to"
    }
  }
}

box_get_folder

Get detailed information about a folder.

Args:

folderId: The ID of the folder (use "0" for root folder)
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Folder details including name, size, dates, owner, and more.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder (use \"0\" for root)"
    }
  }
}

box_list_folder

List items (files and folders) in a folder.

Args:

folderId: The ID of the folder (use "0" for root folder)
limit: Maximum number of items to return
offset: Offset for pagination
marker: Marker for pagination (alternative to offset)
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Paginated list of files, folders, and web links in the folder.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of items to return"
    },
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Marker for pagination"
    },
    "offset": {
      "type": "integer",
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder (use \"0\" for root)"
    }
  }
}

box_create_folder

Create a new folder.

Args:

parentId: The ID of the parent folder (use "0" for root)
name: The name for the new folder

Returns: The created folder object.

{
  "type": "object",
  "required": [
    "parentId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name for the new folder"
    },
    "parentId": {
      "type": "string",
      "description": "The ID of the parent folder (use \"0\" for root)"
    }
  }
}

box_update_folder

Update folder metadata (name, description, parent folder, tags).

Args:

folderId: The ID of the folder to update
name: New name for the folder
description: New description for the folder
parentId: Move folder to this parent folder ID
syncState: Sync state ('synced', 'not_synced', 'partially_synced')
tags: Comma-separated list of tags

Returns: The updated folder object.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "New name for the folder"
    },
    "tags": {
      "type": "string",
      "description": "Comma-separated list of tags"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder to update"
    },
    "parentId": {
      "type": "string",
      "description": "Move folder to this parent folder ID"
    },
    "syncState": {
      "type": "string",
      "description": "Sync state"
    },
    "description": {
      "type": "string",
      "description": "New description for the folder"
    }
  }
}

box_copy_folder

Copy a folder to another location.

Args:

folderId: The ID of the folder to copy
parentId: The ID of the destination parent folder
name: Optional new name for the copied folder

Returns: The copied folder object.

{
  "type": "object",
  "required": [
    "folderId",
    "parentId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Optional new name for the copied folder"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder to copy"
    },
    "parentId": {
      "type": "string",
      "description": "The ID of the destination parent folder"
    }
  }
}

box_delete_folder

Delete a folder (moves to trash).

Args:

folderId: The ID of the folder to delete
recursive: Whether to delete contents recursively (default: false)

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The ID of the folder to delete"
    },
    "recursive": {
      "type": "boolean",
      "default": false,
      "description": "Whether to delete contents recursively"
    }
  }
}

box_get_folder_collaborations

Get all collaborations on a folder.

Args:

folderId: The ID of the folder
limit: Maximum number of collaborations to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of collaborations on the folder.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    }
  }
}

box_get_trashed_folder

Get information about a folder in trash.

Args:

folderId: The ID of the trashed folder
format: Response format ('json' or 'markdown')

Returns: The trashed folder details.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the trashed folder"
    }
  }
}

box_restore_folder

Restore a folder from trash.

Args:

folderId: The ID of the folder to restore
name: Optional new name for the restored folder
parentId: Optional folder ID to restore to

Returns: The restored folder object.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Optional new name for the restored folder"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder to restore"
    },
    "parentId": {
      "type": "string",
      "description": "Optional folder ID to restore to"
    }
  }
}

box_permanently_delete_folder

Permanently delete a folder from trash. This cannot be undone.

Args:

folderId: The ID of the folder to permanently delete

Returns: Confirmation of permanent deletion.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The ID of the folder to permanently delete"
    }
  }
}

box_get_trashed_items

Get all items in trash.

Args:

limit: Maximum number of items to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: Paginated list of trashed items.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of items to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    }
  }
}

box_get_folder_locks

Get all locks on a folder.

Args:

folderId: The ID of the folder
format: Response format ('json' or 'markdown')

Returns: List of folder locks.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    }
  }
}

box_create_folder_lock

Create a lock on a folder to prevent move and delete operations.

Args:

folderId: The ID of the folder to lock

Returns: The created folder lock.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The ID of the folder to lock"
    }
  }
}

box_delete_folder_lock

Remove a lock from a folder.

Args:

lockId: The ID of the folder lock to remove

Returns: Confirmation of lock removal.

{
  "type": "object",
  "required": [
    "lockId"
  ],
  "properties": {
    "lockId": {
      "type": "string",
      "description": "The ID of the folder lock to remove"
    }
  }
}

box_list_groups

List all groups in the enterprise.

Args:

limit: Maximum number of groups to return
offset: Offset for pagination
filterTerm: Search term to filter groups
format: Response format ('json' or 'markdown')

Returns: Paginated list of groups.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of groups to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "filterTerm": {
      "type": "string",
      "description": "Search term to filter groups"
    }
  }
}

box_get_group

Get information about a specific group.

Args:

groupId: The ID of the group
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Group details including name, description, and settings.

{
  "type": "object",
  "required": [
    "groupId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group"
    }
  }
}

box_create_group

Create a new group in the enterprise.

Args:

name: The name of the group
description: Description of the group
provenance: Custom identifier for external groups
externalSyncIdentifier: External sync identifier
invitabilityLevel: Who can invite to the group ('admins_only', 'admins_and_members', 'all_managed_users')
memberViewabilityLevel: Who can view members ('admins_only', 'admins_and_members', 'all_managed_users')

Returns: The created group object.

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the group"
    },
    "provenance": {
      "type": "string",
      "description": "Custom identifier for external groups"
    },
    "description": {
      "type": "string",
      "description": "Description of the group"
    },
    "invitabilityLevel": {
      "enum": [
        "admins_only",
        "admins_and_members",
        "all_managed_users"
      ],
      "type": "string",
      "description": "Who can invite to the group"
    },
    "externalSyncIdentifier": {
      "type": "string",
      "description": "External sync identifier"
    },
    "memberViewabilityLevel": {
      "enum": [
        "admins_only",
        "admins_and_members",
        "all_managed_users"
      ],
      "type": "string",
      "description": "Who can view members"
    }
  }
}

box_update_group

Update a group's information.

Args:

groupId: The ID of the group to update
name: New name for the group
description: New description
provenance: New provenance
externalSyncIdentifier: New external sync identifier
invitabilityLevel: Who can invite to the group
memberViewabilityLevel: Who can view members

Returns: The updated group object.

{
  "type": "object",
  "required": [
    "groupId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "New name for the group"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group to update"
    },
    "provenance": {
      "type": "string",
      "description": "New provenance"
    },
    "description": {
      "type": "string",
      "description": "New description"
    },
    "invitabilityLevel": {
      "enum": [
        "admins_only",
        "admins_and_members",
        "all_managed_users"
      ],
      "type": "string",
      "description": "Who can invite"
    },
    "externalSyncIdentifier": {
      "type": "string",
      "description": "New external sync identifier"
    },
    "memberViewabilityLevel": {
      "enum": [
        "admins_only",
        "admins_and_members",
        "all_managed_users"
      ],
      "type": "string",
      "description": "Who can view members"
    }
  }
}

box_delete_group

Delete a group from the enterprise.

Args:

groupId: The ID of the group to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "groupId"
  ],
  "properties": {
    "groupId": {
      "type": "string",
      "description": "The ID of the group to delete"
    }
  }
}

box_get_group_memberships

Get all members of a group.

Args:

groupId: The ID of the group
limit: Maximum number of memberships to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: List of group memberships.

{
  "type": "object",
  "required": [
    "groupId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group"
    }
  }
}

box_get_group_collaborations

Get all collaborations for a group.

Args:

groupId: The ID of the group
limit: Maximum number of collaborations to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: List of collaborations for the group.

{
  "type": "object",
  "required": [
    "groupId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group"
    }
  }
}

box_get_group_membership

Get a specific group membership.

Args:

membershipId: The ID of the group membership
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Group membership details.

{
  "type": "object",
  "required": [
    "membershipId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "membershipId": {
      "type": "string",
      "description": "The ID of the group membership"
    }
  }
}

box_add_user_to_group

Add a user to a group.

Args:

userId: The ID of the user to add
groupId: The ID of the group
role: Role in the group ('member' or 'admin')

Returns: The created group membership.

{
  "type": "object",
  "required": [
    "userId",
    "groupId"
  ],
  "properties": {
    "role": {
      "enum": [
        "member",
        "admin"
      ],
      "type": "string",
      "default": "member",
      "description": "Role in the group"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to add"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group"
    }
  }
}

box_update_group_membership

Update a user's role in a group.

Args:

membershipId: The ID of the group membership
role: New role ('member' or 'admin')

Returns: The updated group membership.

{
  "type": "object",
  "required": [
    "membershipId",
    "role"
  ],
  "properties": {
    "role": {
      "enum": [
        "member",
        "admin"
      ],
      "type": "string",
      "description": "New role in the group"
    },
    "membershipId": {
      "type": "string",
      "description": "The ID of the group membership"
    }
  }
}

box_remove_user_from_group

Remove a user from a group.

Args:

membershipId: The ID of the group membership to remove

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "membershipId"
  ],
  "properties": {
    "membershipId": {
      "type": "string",
      "description": "The ID of the group membership to remove"
    }
  }
}

box_delete_file_metadata

Remove a metadata instance from a file.

Args:

fileId: The ID of the file
scope: Template scope
templateKey: Template key

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "fileId",
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_list_enterprise_metadata_templates

List all enterprise metadata templates.

Args:

limit: Maximum number of templates to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of enterprise metadata templates.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_list_global_metadata_templates

List all global (Box-provided) metadata templates.

Args:

limit: Maximum number of templates to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of global metadata templates.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_get_metadata_template

Get a metadata template by scope and key.

Args:

scope: Template scope ('enterprise' or 'global')
templateKey: Template key
format: Response format ('json' or 'markdown')

Returns: Metadata template details including fields.

{
  "type": "object",
  "required": [
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope (enterprise or global)"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_create_metadata_template

Create a new enterprise metadata template.

Args:

templateKey: Unique template key (lowercase, underscores allowed)
displayName: Display name for the template
fields: JSON array of field definitions
hidden: Whether template is hidden from UI
copyInstanceOnItemCopy: Copy metadata when item is copied

Field definition format: [ { "type": "string", "key": "field_key", "displayName": "Field Name" }, { "type": "enum", "key": "status", "displayName": "Status", "options": [{"key": "active"}, {"key": "inactive"}] }, { "type": "float", "key": "amount", "displayName": "Amount" }, { "type": "date", "key": "due_date", "displayName": "Due Date" } ]

Field types: string, float, date, enum, multiSelect

Returns: The created metadata template.

{
  "type": "object",
  "required": [
    "templateKey",
    "displayName"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "JSON array of field definitions"
    },
    "hidden": {
      "type": "boolean",
      "default": false,
      "description": "Whether template is hidden"
    },
    "displayName": {
      "type": "string",
      "description": "Display name for the template"
    },
    "templateKey": {
      "type": "string",
      "description": "Unique template key"
    },
    "copyInstanceOnItemCopy": {
      "type": "boolean",
      "default": false,
      "description": "Copy metadata when item is copied"
    }
  }
}

box_delete_metadata_template

Delete a metadata template. Warning: This removes all instances of this template.

Args:

scope: Template scope ('enterprise' or 'global')
templateKey: Template key

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_list_file_metadata

List all metadata instances on a file.

Args:

fileId: The ID of the file
format: Response format ('json' or 'markdown')

Returns: List of metadata instances on the file.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

box_get_file_metadata

Get a specific metadata instance on a file.

Args:

fileId: The ID of the file
scope: Template scope ('enterprise' or 'global')
templateKey: Template key
format: Response format ('json' or 'markdown')

Returns: The metadata instance.

{
  "type": "object",
  "required": [
    "fileId",
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_create_file_metadata

Apply a metadata template to a file.

Args:

fileId: The ID of the file
scope: Template scope ('enterprise' or 'global')
templateKey: Template key
metadata: JSON object with metadata values

Returns: The created metadata instance.

{
  "type": "object",
  "required": [
    "fileId",
    "scope",
    "templateKey",
    "metadata"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "metadata": {
      "type": "string",
      "description": "JSON object with metadata values"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_update_file_metadata

Update metadata on a file using JSON Patch operations.

Args:

fileId: The ID of the file
scope: Template scope
templateKey: Template key
operations: JSON array of patch operations

Operations format: [ { "op": "replace", "path": "/field_key", "value": "new value" }, { "op": "add", "path": "/new_field", "value": "value" }, { "op": "remove", "path": "/field_to_remove" } ]

Returns: The updated metadata instance.

{
  "type": "object",
  "required": [
    "fileId",
    "scope",
    "templateKey",
    "operations"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "operations": {
      "type": "string",
      "description": "JSON array of patch operations"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_get_folder_metadata

Get a specific metadata instance on a folder.

Args:

folderId: The ID of the folder
scope: Template scope
templateKey: Template key
format: Response format ('json' or 'markdown')

Returns: The metadata instance.

{
  "type": "object",
  "required": [
    "folderId",
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_create_folder_metadata

Apply a metadata template to a folder.

Args:

folderId: The ID of the folder
scope: Template scope
templateKey: Template key
metadata: JSON object with metadata values

Returns: The created metadata instance.

{
  "type": "object",
  "required": [
    "folderId",
    "scope",
    "templateKey",
    "metadata"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "metadata": {
      "type": "string",
      "description": "JSON object with metadata values"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_update_folder_metadata

Update metadata on a folder using JSON Patch operations.

Args:

folderId: The ID of the folder
scope: Template scope
templateKey: Template key
operations: JSON array of patch operations

Returns: The updated metadata instance.

{
  "type": "object",
  "required": [
    "folderId",
    "scope",
    "templateKey",
    "operations"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "operations": {
      "type": "string",
      "description": "JSON array of patch operations"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_delete_folder_metadata

Remove a metadata instance from a folder.

Args:

folderId: The ID of the folder
scope: Template scope
templateKey: Template key

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "folderId",
    "scope",
    "templateKey"
  ],
  "properties": {
    "scope": {
      "type": "string",
      "description": "Template scope"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "templateKey": {
      "type": "string",
      "description": "Template key"
    }
  }
}

box_search

Search for files, folders, and web links.

Args:

query: Search query string
type: Filter by item type ('file', 'folder', 'web_link')
ancestorFolderIds: Comma-separated folder IDs to search within
fileExtensions: Comma-separated file extensions to filter (e.g., 'pdf,doc,txt')
contentTypes: Comma-separated content types ('name', 'description', 'file_content', 'comments', 'tags')
createdAtRange: Created date range as 'from,to' in ISO 8601 format
updatedAtRange: Updated date range as 'from,to' in ISO 8601 format
sizeRange: Size range in bytes as 'min,max'
ownerUserIds: Comma-separated owner user IDs
trashContent: Include trash ('non_trashed_only', 'trashed_only', 'all_items')
limit: Maximum number of results to return
offset: Offset for pagination
fields: Comma-separated list of fields to include
sort: Sort field
direction: Sort direction ('ASC' or 'DESC')
format: Response format ('json' or 'markdown')

Returns: Search results with files, folders, and web links matching the query.

{
  "type": "object",
  "required": [
    "query"
  ],
  "properties": {
    "sort": {
      "type": "string",
      "description": "Sort field"
    },
    "type": {
      "enum": [
        "file",
        "folder",
        "web_link"
      ],
      "type": "string",
      "description": "Filter by item type"
    },
    "limit": {
      "type": "integer",
      "default": 30,
      "maximum": 200,
      "minimum": 1,
      "description": "Maximum results"
    },
    "query": {
      "type": "string",
      "description": "Search query string"
    },
    "fields": {
      "type": "string",
      "description": "Fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "direction": {
      "enum": [
        "ASC",
        "DESC"
      ],
      "type": "string",
      "description": "Sort direction"
    },
    "sizeRange": {
      "type": "string",
      "description": "Size range in bytes as min,max"
    },
    "contentTypes": {
      "type": "string",
      "description": "Content types to search"
    },
    "ownerUserIds": {
      "type": "string",
      "description": "Comma-separated owner user IDs"
    },
    "trashContent": {
      "enum": [
        "non_trashed_only",
        "trashed_only",
        "all_items"
      ],
      "type": "string",
      "description": "Include trash"
    },
    "createdAtRange": {
      "type": "string",
      "description": "Created date range as from,to"
    },
    "fileExtensions": {
      "type": "string",
      "description": "Comma-separated file extensions"
    },
    "updatedAtRange": {
      "type": "string",
      "description": "Updated date range as from,to"
    },
    "ancestorFolderIds": {
      "type": "string",
      "description": "Comma-separated folder IDs to search within"
    }
  }
}

box_get_shared_item

Get an item using a shared link URL.

Args:

sharedLink: The shared link URL
password: Password if the shared link is password protected
format: Response format ('json' or 'markdown')

Returns: The file, folder, or web link accessible via the shared link.

{
  "type": "object",
  "required": [
    "sharedLink"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "password": {
      "type": "string",
      "description": "Password if required"
    },
    "sharedLink": {
      "type": "string",
      "description": "The shared link URL"
    }
  }
}

box_create_file_shared_link

Create or update a shared link for a file.

Args:

fileId: The ID of the file
access: Access level ('open', 'company', 'collaborators')
password: Optional password for the shared link
unsharedAt: When the link expires (ISO 8601 format)
canDownload: Allow download via the shared link
canPreview: Allow preview via the shared link
canEdit: Allow editing via the shared link

Returns: The file with its shared_link information.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "access": {
      "enum": [
        "open",
        "company",
        "collaborators"
      ],
      "type": "string",
      "description": "Access level"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "canEdit": {
      "type": "boolean",
      "description": "Allow editing"
    },
    "password": {
      "type": "string",
      "description": "Password for the shared link"
    },
    "canPreview": {
      "type": "boolean",
      "description": "Allow preview"
    },
    "unsharedAt": {
      "type": "string",
      "description": "When the link expires (ISO 8601)"
    },
    "canDownload": {
      "type": "boolean",
      "description": "Allow download"
    }
  }
}

box_get_user

Get information about a specific user.

Args:

userId: The ID of the user
fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: User details including name, login, status, and more.

{
  "type": "object",
  "required": [
    "userId"
  ],
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user"
    }
  }
}

box_create_folder_shared_link

Create or update a shared link for a folder.

Args:

folderId: The ID of the folder
access: Access level ('open', 'company', 'collaborators')
password: Optional password for the shared link
unsharedAt: When the link expires (ISO 8601 format)
canDownload: Allow download via the shared link
canPreview: Allow preview via the shared link

Returns: The folder with its shared_link information.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "access": {
      "enum": [
        "open",
        "company",
        "collaborators"
      ],
      "type": "string",
      "description": "Access level"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    },
    "password": {
      "type": "string",
      "description": "Password for the shared link"
    },
    "canPreview": {
      "type": "boolean",
      "description": "Allow preview"
    },
    "unsharedAt": {
      "type": "string",
      "description": "When the link expires (ISO 8601)"
    },
    "canDownload": {
      "type": "boolean",
      "description": "Allow download"
    }
  }
}

box_remove_file_shared_link

Remove the shared link from a file.

Args:

fileId: The ID of the file

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    }
  }
}

box_remove_folder_shared_link

Remove the shared link from a folder.

Args:

folderId: The ID of the folder

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "folderId"
  ],
  "properties": {
    "folderId": {
      "type": "string",
      "description": "The ID of the folder"
    }
  }
}

box_get_task

Get details about a specific task.

Args:

taskId: The ID of the task
format: Response format ('json' or 'markdown')

Returns: Task details including message, due date, assignments, and status.

{
  "type": "object",
  "required": [
    "taskId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task"
    }
  }
}

box_create_task

Create a task on a file.

Args:

fileId: The ID of the file to create task on
action: Task action type ('review' or 'complete')
message: Optional message/instructions for the task
dueAt: Due date in ISO 8601 format
completionRule: How task is completed ('all_assignees' or 'any_assignee')

Returns: The created task object.

{
  "type": "object",
  "required": [
    "fileId"
  ],
  "properties": {
    "dueAt": {
      "type": "string",
      "description": "Due date in ISO 8601 format"
    },
    "action": {
      "enum": [
        "review",
        "complete"
      ],
      "type": "string",
      "default": "review",
      "description": "Task action type"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "message": {
      "type": "string",
      "description": "Message/instructions for the task"
    },
    "completionRule": {
      "enum": [
        "all_assignees",
        "any_assignee"
      ],
      "type": "string",
      "description": "How task is completed"
    }
  }
}

box_update_task

Update an existing task.

Args:

taskId: The ID of the task to update
action: Task action type ('review' or 'complete')
message: New message/instructions
dueAt: New due date in ISO 8601 format
completionRule: How task is completed

Returns: The updated task object.

{
  "type": "object",
  "required": [
    "taskId"
  ],
  "properties": {
    "dueAt": {
      "type": "string",
      "description": "New due date in ISO 8601 format"
    },
    "action": {
      "enum": [
        "review",
        "complete"
      ],
      "type": "string",
      "description": "Task action type"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task to update"
    },
    "message": {
      "type": "string",
      "description": "New message/instructions"
    },
    "completionRule": {
      "enum": [
        "all_assignees",
        "any_assignee"
      ],
      "type": "string",
      "description": "How task is completed"
    }
  }
}

box_delete_task

Delete a task.

Args:

taskId: The ID of the task to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "taskId"
  ],
  "properties": {
    "taskId": {
      "type": "string",
      "description": "The ID of the task to delete"
    }
  }
}

box_get_task_assignments

Get all assignments for a task.

Args:

taskId: The ID of the task
format: Response format ('json' or 'markdown')

Returns: List of task assignments.

{
  "type": "object",
  "required": [
    "taskId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task"
    }
  }
}

box_get_task_assignment

Get details about a specific task assignment.

Args:

assignmentId: The ID of the task assignment
format: Response format ('json' or 'markdown')

Returns: Task assignment details.

{
  "type": "object",
  "required": [
    "assignmentId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of the task assignment"
    }
  }
}

box_create_task_assignment

Assign a task to a user.

Args:

taskId: The ID of the task
userId: The ID of the user to assign

Returns: The created task assignment.

{
  "type": "object",
  "required": [
    "taskId",
    "userId"
  ],
  "properties": {
    "taskId": {
      "type": "string",
      "description": "The ID of the task"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to assign"
    }
  }
}

box_update_task_assignment

Update a task assignment (e.g., mark as complete).

Args:

assignmentId: The ID of the task assignment
message: Optional message/comment
resolutionState: Resolution state ('completed', 'incomplete', 'approved', 'rejected')

Returns: The updated task assignment.

{
  "type": "object",
  "required": [
    "assignmentId"
  ],
  "properties": {
    "message": {
      "type": "string",
      "description": "Optional message/comment"
    },
    "assignmentId": {
      "type": "string",
      "description": "The ID of the task assignment"
    },
    "resolutionState": {
      "enum": [
        "completed",
        "incomplete",
        "approved",
        "rejected"
      ],
      "type": "string",
      "description": "Resolution state"
    }
  }
}

box_delete_task_assignment

Remove a task assignment.

Args:

assignmentId: The ID of the task assignment to remove

Returns: Confirmation of removal.

{
  "type": "object",
  "required": [
    "assignmentId"
  ],
  "properties": {
    "assignmentId": {
      "type": "string",
      "description": "The ID of the task assignment to remove"
    }
  }
}

box_get_current_user

Get information about the currently authenticated user.

Args:

fields: Comma-separated list of fields to include
format: Response format ('json' or 'markdown')

Returns: Current user details including name, login, status, and more.

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "string",
      "description": "Comma-separated list of fields to include"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    }
  }
}

box_list_users

List all users in the enterprise.

Args:

limit: Maximum number of users to return
offset: Offset for pagination
filterTerm: Search term to filter users
userType: Filter by user type ('all', 'managed', 'external')
format: Response format ('json' or 'markdown')

Returns: Paginated list of users.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number of users to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "userType": {
      "type": "string",
      "description": "Filter by user type"
    },
    "filterTerm": {
      "type": "string",
      "description": "Search term to filter users"
    }
  }
}

box_create_user

Create a new managed user in the enterprise.

Args:

login: User's login email
name: User's display name
role: User role ('admin', 'coadmin', 'user')
language: User's language
jobTitle: User's job title
phone: User's phone number
address: User's address
spaceAmount: User's total available space in bytes
timezone: User's timezone
isPlatformAccessOnly: Whether user is app user only

Returns: The created user object.

{
  "type": "object",
  "required": [
    "login",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "User's display name"
    },
    "role": {
      "enum": [
        "admin",
        "coadmin",
        "user"
      ],
      "type": "string",
      "description": "User role"
    },
    "login": {
      "type": "string",
      "description": "User's login email"
    },
    "phone": {
      "type": "string",
      "description": "User's phone number"
    },
    "address": {
      "type": "string",
      "description": "User's address"
    },
    "jobTitle": {
      "type": "string",
      "description": "User's job title"
    },
    "language": {
      "type": "string",
      "description": "User's language"
    },
    "timezone": {
      "type": "string",
      "description": "User's timezone"
    },
    "spaceAmount": {
      "type": "integer",
      "description": "User's total available space in bytes"
    },
    "isPlatformAccessOnly": {
      "type": "boolean",
      "description": "Whether user is app user only"
    }
  }
}

box_update_user

Update a user's information.

Args:

userId: The ID of the user to update
name: New display name
login: New login email
role: New role ('admin', 'coadmin', 'user')
jobTitle: New job title
phone: New phone number
address: New address
status: User status ('active', 'inactive')
notify: Whether to send notification email

Returns: The updated user object.

{
  "type": "object",
  "required": [
    "userId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "New display name"
    },
    "role": {
      "enum": [
        "admin",
        "coadmin",
        "user"
      ],
      "type": "string",
      "description": "New role"
    },
    "login": {
      "type": "string",
      "description": "New login email"
    },
    "phone": {
      "type": "string",
      "description": "New phone number"
    },
    "notify": {
      "type": "boolean",
      "description": "Whether to send notification email"
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "description": "User status"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to update"
    },
    "address": {
      "type": "string",
      "description": "New address"
    },
    "jobTitle": {
      "type": "string",
      "description": "New job title"
    }
  }
}

box_delete_user

Delete a user from the enterprise.

Args:

userId: The ID of the user to delete
notify: Whether to send a notification email (default: true)
force: Whether to force delete even if user owns content (default: false)

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "userId"
  ],
  "properties": {
    "force": {
      "type": "boolean",
      "default": false,
      "description": "Whether to force delete"
    },
    "notify": {
      "type": "boolean",
      "default": true,
      "description": "Whether to send a notification email"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to delete"
    }
  }
}

box_get_user_memberships

Get all group memberships for a user.

Args:

userId: The ID of the user
limit: Maximum number of memberships to return
offset: Offset for pagination
format: Response format ('json' or 'markdown')

Returns: List of group memberships for the user.

{
  "type": "object",
  "required": [
    "userId"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 1000,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "offset": {
      "type": "integer",
      "default": 0,
      "minimum": 0,
      "description": "Offset for pagination"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user"
    }
  }
}

box_get_web_link

Get details about a web link (bookmark).

Args:

webLinkId: The ID of the web link
format: Response format ('json' or 'markdown')

Returns: Web link details including URL, name, and parent folder.

{
  "type": "object",
  "required": [
    "webLinkId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "webLinkId": {
      "type": "string",
      "description": "The ID of the web link"
    }
  }
}

box_create_web_link

Create a web link (bookmark) in a folder.

Args:

folderId: The ID of the parent folder
url: The URL the web link points to
name: Optional name for the web link
description: Optional description

Returns: The created web link.

{
  "type": "object",
  "required": [
    "folderId",
    "url"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL the web link points to"
    },
    "name": {
      "type": "string",
      "description": "Name for the web link"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the parent folder"
    },
    "description": {
      "type": "string",
      "description": "Description"
    }
  }
}

box_update_web_link

Update a web link's properties.

Args:

webLinkId: The ID of the web link to update
url: New URL
name: New name
description: New description
parentId: Move to this folder ID

Returns: The updated web link.

{
  "type": "object",
  "required": [
    "webLinkId"
  ],
  "properties": {
    "url": {
      "type": "string",
      "description": "New URL"
    },
    "name": {
      "type": "string",
      "description": "New name"
    },
    "parentId": {
      "type": "string",
      "description": "Move to this folder ID"
    },
    "webLinkId": {
      "type": "string",
      "description": "The ID of the web link to update"
    },
    "description": {
      "type": "string",
      "description": "New description"
    }
  }
}

box_delete_web_link

Delete a web link (moves to trash).

Args:

webLinkId: The ID of the web link to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "webLinkId"
  ],
  "properties": {
    "webLinkId": {
      "type": "string",
      "description": "The ID of the web link to delete"
    }
  }
}

box_get_trashed_web_link

Get information about a web link in trash.

Args:

webLinkId: The ID of the trashed web link
format: Response format ('json' or 'markdown')

Returns: The trashed web link details.

{
  "type": "object",
  "required": [
    "webLinkId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "webLinkId": {
      "type": "string",
      "description": "The ID of the trashed web link"
    }
  }
}

box_restore_web_link

Restore a web link from trash.

Args:

webLinkId: The ID of the web link to restore
name: Optional new name
parentId: Optional folder ID to restore to

Returns: The restored web link.

{
  "type": "object",
  "required": [
    "webLinkId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Optional new name"
    },
    "parentId": {
      "type": "string",
      "description": "Optional folder ID to restore to"
    },
    "webLinkId": {
      "type": "string",
      "description": "The ID of the web link to restore"
    }
  }
}

box_permanently_delete_web_link

Permanently delete a web link from trash. This cannot be undone.

Args:

webLinkId: The ID of the web link to permanently delete

Returns: Confirmation of permanent deletion.

{
  "type": "object",
  "required": [
    "webLinkId"
  ],
  "properties": {
    "webLinkId": {
      "type": "string",
      "description": "The ID of the web link to permanently delete"
    }
  }
}

box_list_webhooks

List all webhooks.

Args:

limit: Maximum number of webhooks to return
marker: Pagination marker
format: Response format ('json' or 'markdown')

Returns: List of webhooks.

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "default": 100,
      "maximum": 200,
      "minimum": 1,
      "description": "Maximum number to return"
    },
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "marker": {
      "type": "string",
      "description": "Pagination marker"
    }
  }
}

box_get_webhook

Get details about a specific webhook.

Args:

webhookId: The ID of the webhook
format: Response format ('json' or 'markdown')

Returns: Webhook details including target, triggers, and address.

{
  "type": "object",
  "required": [
    "webhookId"
  ],
  "properties": {
    "format": {
      "enum": [
        "json",
        "markdown"
      ],
      "type": "string",
      "default": "json",
      "description": "Response format"
    },
    "webhookId": {
      "type": "string",
      "description": "The ID of the webhook"
    }
  }
}

box_create_webhook

Create a webhook on a file or folder.

Args:

targetId: The ID of the file or folder
targetType: Type of target ('file' or 'folder')
address: URL to receive webhook notifications (must be HTTPS)
triggers: Comma-separated list of event triggers

Available triggers for files: FILE.UPLOADED, FILE.PREVIEWED, FILE.DOWNLOADED, FILE.TRASHED, FILE.DELETED, FILE.RESTORED, FILE.COPIED, FILE.MOVED, FILE.LOCKED, FILE.UNLOCKED, FILE.RENAMED, COMMENT.CREATED, COMMENT.UPDATED, COMMENT.DELETED, TASK_ASSIGNMENT.CREATED, TASK_ASSIGNMENT.UPDATED, METADATA_INSTANCE.CREATED, METADATA_INSTANCE.UPDATED, METADATA_INSTANCE.DELETED, SHARED_LINK.CREATED, SHARED_LINK.DELETED, SHARED_LINK.UPDATED

Available triggers for folders: FOLDER.CREATED, FOLDER.RENAMED, FOLDER.DOWNLOADED, FOLDER.RESTORED, FOLDER.DELETED, FOLDER.COPIED, FOLDER.MOVED, FOLDER.TRASHED

Returns: The created webhook.

{
  "type": "object",
  "required": [
    "targetId",
    "targetType",
    "address",
    "triggers"
  ],
  "properties": {
    "address": {
      "type": "string",
      "description": "URL to receive webhook notifications"
    },
    "targetId": {
      "type": "string",
      "description": "The ID of the file or folder"
    },
    "triggers": {
      "type": "string",
      "description": "Comma-separated list of event triggers"
    },
    "targetType": {
      "enum": [
        "file",
        "folder"
      ],
      "type": "string",
      "description": "Type of target"
    }
  }
}

box_update_webhook

Update a webhook's address or triggers.

Args:

webhookId: The ID of the webhook to update
address: New URL to receive notifications
triggers: New comma-separated list of triggers

Returns: The updated webhook.

{
  "type": "object",
  "required": [
    "webhookId"
  ],
  "properties": {
    "address": {
      "type": "string",
      "description": "New URL to receive notifications"
    },
    "triggers": {
      "type": "string",
      "description": "New comma-separated list of triggers"
    },
    "webhookId": {
      "type": "string",
      "description": "The ID of the webhook to update"
    }
  }
}

box_delete_webhook

Delete a webhook.

Args:

webhookId: The ID of the webhook to delete

Returns: Confirmation of deletion.

{
  "type": "object",
  "required": [
    "webhookId"
  ],
  "properties": {
    "webhookId": {
      "type": "string",
      "description": "The ID of the webhook to delete"
    }
  }
}