# API Reference This section contains 552 documentation items covering resource, endpoint. Includes 313 API endpoints and 239 resource definitions. ## Access token *Type: resource | Category: api-resource* A token that can be used to make authenticated API calls. # Access token A token that can be used to make authenticated API calls. --- ## Add changed status of shield information barrier with specified ID *Type: endpoint | Category: api-endpoint* # undefined /reference/post-shield-information-barriers-change-status/ **Reference:** https://developer.box.com/reference/post-shield-information-barriers-change-status/ --- ## Add classification *Type: endpoint | Category: api-endpoint* # undefined /reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add/ **Reference:** https://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add/ --- ## Add classification to file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Add classification to folder *Type: endpoint | Category: api-endpoint* # undefined /reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Add domain to list of allowed collaboration domains *Type: endpoint | Category: api-endpoint* # undefined /reference/post-collaboration-whitelist-entries/ **Reference:** https://developer.box.com/reference/post-collaboration-whitelist-entries/ --- ## Add initial classifications *Type: endpoint | Category: api-endpoint* # undefined /reference/post-metadata-templates-schema--classifications/ **Reference:** https://developer.box.com/reference/post-metadata-templates-schema--classifications/ --- ## Add or update user avatar *Type: endpoint | Category: api-endpoint* # undefined /reference/post-users-id-avatar/ **Reference:** https://developer.box.com/reference/post-users-id-avatar/ --- ## Add shared link to file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id--add-shared-link/ **Reference:** https://developer.box.com/reference/put-files-id--add-shared-link/ --- ## Add shared link to folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id--add-shared-link/ **Reference:** https://developer.box.com/reference/put-folders-id--add-shared-link/ --- ## Add shared link to web link *Type: endpoint | Category: api-endpoint* # undefined /reference/put-web-links-id--add-shared-link/ **Reference:** https://developer.box.com/reference/put-web-links-id--add-shared-link/ --- ## Add user to group *Type: endpoint | Category: api-endpoint* # undefined /reference/post-group-memberships/ **Reference:** https://developer.box.com/reference/post-group-memberships/ --- ## AI agent *Type: resource | Category: api-resource* Standard representation of an AI Agent instance. # AI agent Standard representation of an AI Agent instance. --- ## AI agent (Full) *Type: resource | Category: api-resource* Full representation of an AI Agent instance. # AI agent (Full) Full representation of an AI Agent instance. --- ## AI agent capability ask *Type: resource | Category: api-resource* The AI agent to be used to ask questions. # AI agent capability ask The AI agent to be used to ask questions. --- ## AI agent capability ask request *Type: resource | Category: api-resource* The AI agent to be used to handle queries. # AI agent capability ask request The AI agent to be used to handle queries. --- ## AI agent capability extract *Type: resource | Category: api-resource* The AI agent to be used for metadata extraction. # AI agent capability extract The AI agent to be used for metadata extraction. --- ## AI agent capability extract request *Type: resource | Category: api-resource* The AI agent to be used for metadata extraction. # AI agent capability extract request The AI agent to be used for metadata extraction. --- ## AI agent capability text generation *Type: resource | Category: api-resource* The AI agent to be used to generate text. # AI agent capability text generation The AI agent to be used to generate text. --- ## AI agent capability text generation request *Type: resource | Category: api-resource* The AI agent to be used to generate text. # AI agent capability text generation request The AI agent to be used to generate text. --- ## AI agent for extract requests *Type: resource | Category: api-resource* The AI agent to be used for extraction. # AI agent for extract requests The AI agent to be used for extraction. --- ## AI agent for question requests *Type: resource | Category: api-resource* The AI agent used to handle queries. # AI agent for question requests The AI agent used to handle queries. --- ## AI agent for structured extract request *Type: resource | Category: api-resource* The AI agent to be used for structured extraction. # AI agent for structured extract request The AI agent to be used for structured extraction. --- ## AI agent for text generation requests *Type: resource | Category: api-resource* The AI agent used for generating text. # AI agent for text generation requests The AI agent used for generating text. --- ## AI agent reference *Type: resource | Category: api-resource* The AI agent used to handle queries. # AI agent reference The AI agent used to handle queries. --- ## AI agents list *Type: resource | Category: api-resource* List of AI Agents with pagination. # AI agents list List of AI Agents with pagination. --- ## AI extract response *Type: resource | Category: api-resource* AI extract response. The content of this response may vary depending on the requested configuration. # AI extract response AI extract response. The content of this response may vary depending on the requested configuration. --- ## AI extract structured response *Type: resource | Category: api-resource* AI extract structured response. # AI extract structured response AI extract structured response. --- ## AI LLM endpoint params AWS *Type: resource | Category: api-resource* AI LLM endpoint params AWS object. # AI LLM endpoint params AWS AI LLM endpoint params AWS object. --- ## AI LLM endpoint params Google *Type: resource | Category: api-resource* AI LLM endpoint params Google object. # AI LLM endpoint params Google AI LLM endpoint params Google object. --- ## AI LLM endpoint params IBM *Type: resource | Category: api-resource* AI LLM endpoint params IBM object. # AI LLM endpoint params IBM AI LLM endpoint params IBM object. --- ## AI LLM endpoint params OpenAI *Type: resource | Category: api-resource* AI LLM endpoint params OpenAI object. # AI LLM endpoint params OpenAI AI LLM endpoint params OpenAI object. --- ## AI response *Type: resource | Category: api-resource* AI response. # AI response AI response. --- ## AI response (Full) *Type: resource | Category: api-resource* AI ask response. # AI response (Full) AI ask response. --- ## Allowed collaboration domain *Type: resource | Category: api-resource* An entry that describes an approved domain for which users can collaborate with files and folders in your enterprise or vice versa. # Allowed collaboration domain An entry that describes an approved domain for which users can collaborate with files and folders in your enterprise or vice versa. --- ## Allowed collaboration domains *Type: resource | Category: api-resource* A list of allowed domains for collaboration. # Allowed collaboration domains A list of allowed domains for collaboration. --- ## Allowed collaboration domains user exemption *Type: resource | Category: api-resource* The user that is exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise. # Allowed collaboration domains user exemption The user that is exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise. --- ## Allowed collaboration domains user exemptions *Type: resource | Category: api-resource* A list of users exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise. # Allowed collaboration domains user exemptions A list of users exempt from any of the restrictions imposed by the list of allowed collaboration domains for this enterprise. --- ## App item *Type: resource | Category: api-resource* An app item represents an content object owned by an application. It can group files and folders together from different paths. That set can be shared via a collaboration. # App item An app item represents an content object owned by an application. It can group files and folders together from different paths. That set can be shared via a collaboration. --- ## App item association *Type: resource | Category: api-resource* An app item association represents an association between a file or folder and an app item. Associations between a folder and an app item cascade down to all descendants of the folder. # App item association An app item association represents an association between a file or folder and an app item. Associations between a folder and an app item cascade down to all descendants of the folder. --- ## App item associations *Type: resource | Category: api-resource* A list of app item associations. # App item associations A list of app item associations. --- ## AppItem event source *Type: resource | Category: api-resource* The AppItem that triggered an event in the event stream. # AppItem event source The AppItem that triggered an event in the event stream. --- ## Apply watermark to file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id-watermark/ **Reference:** https://developer.box.com/reference/put-files-id-watermark/ --- ## Apply watermark to folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id-watermark/ **Reference:** https://developer.box.com/reference/put-folders-id-watermark/ --- ## Archive *Type: resource | Category: api-resource* An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its owner and collaborators. To use this feature, you must request GCM scope for your Box application. # Archive An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its owner and collaborators. To use this feature, you must request GCM scope for your Box application. --- ## Archives *Type: resource | Category: api-resource* A list of archives. # Archives A list of archives. --- ## Ask question *Type: endpoint | Category: api-endpoint* # undefined /reference/post-ai-ask/ **Reference:** https://developer.box.com/reference/post-ai-ask/ --- ## Assign legal hold policy *Type: endpoint | Category: api-endpoint* # undefined /reference/post-legal-hold-policy-assignments/ **Reference:** https://developer.box.com/reference/post-legal-hold-policy-assignments/ --- ## Assign retention policy *Type: endpoint | Category: api-endpoint* # undefined /reference/post-retention-policy-assignments/ **Reference:** https://developer.box.com/reference/post-retention-policy-assignments/ --- ## Assign storage policy *Type: endpoint | Category: api-endpoint* # undefined /reference/post-storage-policy-assignments/ **Reference:** https://developer.box.com/reference/post-storage-policy-assignments/ --- ## Assign task *Type: endpoint | Category: api-endpoint* # undefined /reference/post-task-assignments/ **Reference:** https://developer.box.com/reference/post-task-assignments/ --- ## Authorize user *Type: endpoint | Category: api-endpoint* # undefined /reference/get-authorize/ **Reference:** https://developer.box.com/reference/get-authorize/ --- ## Box Doc Gen batch (Base) *Type: resource | Category: api-resource* The basic representation of a Box Doc Gen batch object. A Box Doc Gen batch contains one or more Box Doc Gen jobs. # Box Doc Gen batch (Base) The basic representation of a Box Doc Gen batch object. A Box Doc Gen batch contains one or more Box Doc Gen jobs. --- ## Box Doc Gen job *Type: resource | Category: api-resource* A standard representation of a Box Doc Gen job. # Box Doc Gen job A standard representation of a Box Doc Gen job. --- ## Box Doc Gen job (Base) *Type: resource | Category: api-resource* The basic representation of a Box Doc Gen job. # Box Doc Gen job (Base) The basic representation of a Box Doc Gen job. --- ## Box Doc Gen job (Full) *Type: resource | Category: api-resource* A full representation of a Box Doc Gen job. # Box Doc Gen job (Full) A full representation of a Box Doc Gen job. --- ## Box Doc Gen jobs *Type: resource | Category: api-resource* A list of Box Doc Gen jobs with a standard set of parameters. # Box Doc Gen jobs A list of Box Doc Gen jobs with a standard set of parameters. --- ## Box Doc Gen jobs (Full) *Type: resource | Category: api-resource* A list of Box Doc Gen jobs with a full set of parameters. # Box Doc Gen jobs (Full) A list of Box Doc Gen jobs with a full set of parameters. --- ## Box Doc Gen tags *Type: resource | Category: api-resource* A list of Box Doc Gen tags. # Box Doc Gen tags A list of Box Doc Gen tags. --- ## Box Doc Gen tags processing message *Type: resource | Category: api-resource* A message informing the user that document tags are still being processed. # Box Doc Gen tags processing message A message informing the user that document tags are still being processed. --- ## Box Doc Gen template *Type: resource | Category: api-resource* A Box Doc Gen template object. # Box Doc Gen template A Box Doc Gen template object. --- ## Box Doc Gen template (Base) *Type: resource | Category: api-resource* A base representation of a Box Doc Gen template, used when nested within another resource. # Box Doc Gen template (Base) A base representation of a Box Doc Gen template, used when nested within another resource. --- ## Box Doc Gen template tag *Type: resource | Category: api-resource* A Box Doc Gen template tag object. # Box Doc Gen template tag A Box Doc Gen template tag object. --- ## Box Doc Gen templates *Type: resource | Category: api-resource* List of Box Doc Gen templates. # Box Doc Gen templates List of Box Doc Gen templates. --- ## Box Sign request *Type: resource | Category: api-resource* A Box Sign request object. # Box Sign request A Box Sign request object. --- ## Box Sign requests *Type: resource | Category: api-resource* A standard representation of a signature request, as returned from any Box Sign API endpoints by default. # Box Sign requests A standard representation of a signature request, as returned from any Box Sign API endpoints by default. --- ## Box Sign template *Type: resource | Category: api-resource* A Box Sign template object. # Box Sign template A Box Sign template object. --- ## Box Sign templates *Type: resource | Category: api-resource* A list of templates, as returned from any Box Sign API endpoints by default. # Box Sign templates A list of templates, as returned from any Box Sign API endpoints by default. --- ## Cancel Box Sign request *Type: endpoint | Category: api-endpoint* # undefined /reference/post-sign-requests-id-cancel/ **Reference:** https://developer.box.com/reference/post-sign-requests-id-cancel/ --- ## Classification *Type: resource | Category: api-resource* An instance of the classification metadata template, containing the classification applied to the file or folder. To get more details about the classification applied to an item, request the classification metadata template. # Classification An instance of the classification metadata template, containing the classification applied to the file or folder. To get more details about the classification applied to an item, request the classification metadata template. --- ## Classification Template *Type: resource | Category: api-resource* A metadata template that holds the security classifications defined by an enterprise. # Classification Template A metadata template that holds the security classifications defined by an enterprise. --- ## Client error *Type: resource | Category: api-resource* A generic error. # Client error A generic error. --- ## Client error *Type: resource | Category: api-resource* A generic error. # Client error A generic error. --- ## Collaboration *Type: resource | Category: api-resource* Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role. # Collaboration Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or group access to a file or folder with permissions defined by a specific role. --- ## Collaborations *Type: resource | Category: api-resource* A list of collaborations. # Collaborations A list of collaborations. --- ## Collaborations *Type: resource | Category: api-resource* A list of collaborations. # Collaborations A list of collaborations. --- ## Collection *Type: resource | Category: api-resource* A collection of items, including files and folders. Currently, the only collection available is the `favorites` collection. The contents of a collection can be explored in a similar way to which the contents of a folder is explored. # Collection A collection of items, including files and folders. Currently, the only collection available is the `favorites` collection. The contents of a collection can be explored in a similar way to which the contents of a folder is explored. --- ## Collections *Type: resource | Category: api-resource* A list of collections. # Collections A list of collections. --- ## Comment *Type: resource | Category: api-resource* Standard representation of a comment. # Comment Standard representation of a comment. --- ## Comment (Base) *Type: resource | Category: api-resource* Base representation of a comment. # Comment (Base) Base representation of a comment. --- ## Comment (Full) *Type: resource | Category: api-resource* Comments are messages created on files. Comments can be made independently or created as responses to other comments. # Comment (Full) Comments are messages created on files. Comments can be made independently or created as responses to other comments. --- ## Comments *Type: resource | Category: api-resource* A list of comments. # Comments A list of comments. --- ## Commit upload session *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-upload-sessions-id-commit/ **Reference:** https://developer.box.com/reference/post-files-upload-sessions-id-commit/ --- ## Conflict error *Type: resource | Category: api-resource* The error that occurs when a file can not be created due to a conflict. # Conflict error The error that occurs when a file can not be created due to a conflict. --- ## Copy file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-copy/ **Reference:** https://developer.box.com/reference/post-files-id-copy/ --- ## Copy file request *Type: endpoint | Category: api-endpoint* # undefined /reference/post-file-requests-id-copy/ **Reference:** https://developer.box.com/reference/post-file-requests-id-copy/ --- ## Copy folder *Type: endpoint | Category: api-endpoint* # undefined /reference/post-folders-id-copy/ **Reference:** https://developer.box.com/reference/post-folders-id-copy/ --- ## Copy hub *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-hubs-id-copy/ **Reference:** https://developer.box.com/reference/v2025.0/post-hubs-id-copy/ --- ## Create a Box Sign request *Type: resource | Category: api-resource* Creates a Box Sign request object. # Create a Box Sign request Creates a Box Sign request object. --- ## Create AI agent *Type: endpoint | Category: api-endpoint* # undefined /reference/post-ai-agents/ **Reference:** https://developer.box.com/reference/post-ai-agents/ --- ## Create archive *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-archives/ **Reference:** https://developer.box.com/reference/v2025.0/post-archives/ --- ## Create Box Doc Gen template *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-docgen-templates/ **Reference:** https://developer.box.com/reference/v2025.0/post-docgen-templates/ --- ## Create Box Sign request *Type: endpoint | Category: api-endpoint* # undefined /reference/post-sign-requests/ **Reference:** https://developer.box.com/reference/post-sign-requests/ --- ## Create Box Skill cards on file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-metadata-global-boxSkillsCards/ **Reference:** https://developer.box.com/reference/post-files-id-metadata-global-boxSkillsCards/ --- ## Create collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/post-collaborations/ **Reference:** https://developer.box.com/reference/post-collaborations/ --- ## Create comment *Type: endpoint | Category: api-endpoint* # undefined /reference/post-comments/ **Reference:** https://developer.box.com/reference/post-comments/ --- ## Create email alias *Type: endpoint | Category: api-endpoint* # undefined /reference/post-users-id-email-aliases/ **Reference:** https://developer.box.com/reference/post-users-id-email-aliases/ --- ## Create folder *Type: endpoint | Category: api-endpoint* # undefined /reference/post-folders/ **Reference:** https://developer.box.com/reference/post-folders/ --- ## Create folder lock *Type: endpoint | Category: api-endpoint* # undefined /reference/post-folder-locks/ **Reference:** https://developer.box.com/reference/post-folder-locks/ --- ## Create group *Type: endpoint | Category: api-endpoint* # undefined /reference/post-groups/ **Reference:** https://developer.box.com/reference/post-groups/ --- ## Create hub *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-hubs/ **Reference:** https://developer.box.com/reference/v2025.0/post-hubs/ --- ## Create hub collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-hub-collaborations/ **Reference:** https://developer.box.com/reference/v2025.0/post-hub-collaborations/ --- ## Create jobs to terminate user group session *Type: endpoint | Category: api-endpoint* # undefined /reference/post-groups-terminate-sessions/ **Reference:** https://developer.box.com/reference/post-groups-terminate-sessions/ --- ## Create jobs to terminate users session *Type: endpoint | Category: api-endpoint* # undefined /reference/post-users-terminate-sessions/ **Reference:** https://developer.box.com/reference/post-users-terminate-sessions/ --- ## Create legal hold policy *Type: endpoint | Category: api-endpoint* # undefined /reference/post-legal-hold-policies/ **Reference:** https://developer.box.com/reference/post-legal-hold-policies/ --- ## Create metadata cascade policy *Type: endpoint | Category: api-endpoint* # undefined /reference/post-metadata-cascade-policies/ **Reference:** https://developer.box.com/reference/post-metadata-cascade-policies/ --- ## Create metadata instance on file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/post-files-id-metadata-id-id/ --- ## Create metadata instance on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/post-folders-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/post-folders-id-metadata-id-id/ --- ## Create metadata template *Type: endpoint | Category: api-endpoint* # undefined /reference/post-metadata-templates-schema/ **Reference:** https://developer.box.com/reference/post-metadata-templates-schema/ --- ## Create retention policy *Type: endpoint | Category: api-endpoint* # undefined /reference/post-retention-policies/ **Reference:** https://developer.box.com/reference/post-retention-policies/ --- ## Create shield information barrier *Type: endpoint | Category: api-endpoint* # undefined /reference/post-shield-information-barriers/ **Reference:** https://developer.box.com/reference/post-shield-information-barriers/ --- ## Create shield information barrier report *Type: endpoint | Category: api-endpoint* # undefined /reference/post-shield-information-barrier-reports/ **Reference:** https://developer.box.com/reference/post-shield-information-barrier-reports/ --- ## Create shield information barrier segment *Type: endpoint | Category: api-endpoint* # undefined /reference/post-shield-information-barrier-segments/ **Reference:** https://developer.box.com/reference/post-shield-information-barrier-segments/ --- ## Create shield information barrier segment member *Type: endpoint | Category: api-endpoint* # undefined /reference/post-shield-information-barrier-segment-members/ **Reference:** https://developer.box.com/reference/post-shield-information-barrier-segment-members/ --- ## Create shield information barrier segment restriction *Type: endpoint | Category: api-endpoint* # undefined /reference/post-shield-information-barrier-segment-restrictions/ **Reference:** https://developer.box.com/reference/post-shield-information-barrier-segment-restrictions/ --- ## Create shield list *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-shield-lists/ **Reference:** https://developer.box.com/reference/v2025.0/post-shield-lists/ --- ## Create Slack integration mapping *Type: endpoint | Category: api-endpoint* # undefined /reference/post-integration-mappings-slack/ **Reference:** https://developer.box.com/reference/post-integration-mappings-slack/ --- ## Create Slack integration mapping request *Type: resource | Category: api-resource* A request to create a Slack Integration Mapping object. # Create Slack integration mapping request A request to create a Slack Integration Mapping object. --- ## Create task *Type: endpoint | Category: api-endpoint* # undefined /reference/post-tasks/ **Reference:** https://developer.box.com/reference/post-tasks/ --- ## Create Teams integration mapping *Type: endpoint | Category: api-endpoint* # undefined /reference/post-integration-mappings-teams/ **Reference:** https://developer.box.com/reference/post-integration-mappings-teams/ --- ## Create teams integration mapping request *Type: resource | Category: api-resource* A request to create a Teams Integration Mapping object. # Create teams integration mapping request A request to create a Teams Integration Mapping object. --- ## Create terms of service *Type: endpoint | Category: api-endpoint* # undefined /reference/post-terms-of-services/ **Reference:** https://developer.box.com/reference/post-terms-of-services/ --- ## Create terms of service status for new user *Type: endpoint | Category: api-endpoint* # undefined /reference/post-terms-of-service-user-statuses/ **Reference:** https://developer.box.com/reference/post-terms-of-service-user-statuses/ --- ## Create upload session *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-upload-sessions/ **Reference:** https://developer.box.com/reference/post-files-upload-sessions/ --- ## Create upload session for existing file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-upload-sessions/ **Reference:** https://developer.box.com/reference/post-files-id-upload-sessions/ --- ## Create user *Type: endpoint | Category: api-endpoint* # undefined /reference/post-users/ **Reference:** https://developer.box.com/reference/post-users/ --- ## Create user exemption from collaboration domain restrictions *Type: endpoint | Category: api-endpoint* # undefined /reference/post-collaboration-whitelist-exempt-targets/ **Reference:** https://developer.box.com/reference/post-collaboration-whitelist-exempt-targets/ --- ## Create user invite *Type: endpoint | Category: api-endpoint* # undefined /reference/post-invites/ **Reference:** https://developer.box.com/reference/post-invites/ --- ## Create web link *Type: endpoint | Category: api-endpoint* # undefined /reference/post-web-links/ **Reference:** https://developer.box.com/reference/post-web-links/ --- ## Create webhook *Type: endpoint | Category: api-endpoint* # undefined /reference/post-webhooks/ **Reference:** https://developer.box.com/reference/post-webhooks/ --- ## Create zip download *Type: endpoint | Category: api-endpoint* # undefined /reference/post-zip-downloads/ **Reference:** https://developer.box.com/reference/post-zip-downloads/ --- ## Delete AI agent *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-ai-agents-id/ **Reference:** https://developer.box.com/reference/delete-ai-agents-id/ --- ## Delete archive *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/delete-archives-id/ **Reference:** https://developer.box.com/reference/v2025.0/delete-archives-id/ --- ## Delete Box Doc Gen template *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/delete-docgen-templates-id/ **Reference:** https://developer.box.com/reference/v2025.0/delete-docgen-templates-id/ --- ## Delete file *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id/ **Reference:** https://developer.box.com/reference/delete-files-id/ --- ## Delete file request *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-file-requests-id/ **Reference:** https://developer.box.com/reference/delete-file-requests-id/ --- ## Delete folder *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-folders-id/ **Reference:** https://developer.box.com/reference/delete-folders-id/ --- ## Delete folder lock *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-folder-locks-id/ **Reference:** https://developer.box.com/reference/delete-folder-locks-id/ --- ## Delete hub *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/delete-hubs-id/ **Reference:** https://developer.box.com/reference/v2025.0/delete-hubs-id/ --- ## Delete retention policy *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-retention-policies-id/ **Reference:** https://developer.box.com/reference/delete-retention-policies-id/ --- ## Delete shield information barrier segment *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-shield-information-barrier-segments-id/ **Reference:** https://developer.box.com/reference/delete-shield-information-barrier-segments-id/ --- ## Delete shield information barrier segment member by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-shield-information-barrier-segment-members-id/ **Reference:** https://developer.box.com/reference/delete-shield-information-barrier-segment-members-id/ --- ## Delete shield information barrier segment restriction by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-shield-information-barrier-segment-restrictions-id/ **Reference:** https://developer.box.com/reference/delete-shield-information-barrier-segment-restrictions-id/ --- ## Delete single shield list by shield list id *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/delete-shield-lists-id/ **Reference:** https://developer.box.com/reference/v2025.0/delete-shield-lists-id/ --- ## Delete Slack integration mapping *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-integration-mappings-slack-id/ **Reference:** https://developer.box.com/reference/delete-integration-mappings-slack-id/ --- ## Delete Teams integration mapping *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-integration-mappings-teams-id/ **Reference:** https://developer.box.com/reference/delete-integration-mappings-teams-id/ --- ## Delete user *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-users-id/ **Reference:** https://developer.box.com/reference/delete-users-id/ --- ## Delete user avatar *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-users-id-avatar/ **Reference:** https://developer.box.com/reference/delete-users-id-avatar/ --- ## Device pinner *Type: resource | Category: api-resource* Device pins allow enterprises to control what devices can use native Box applications. # Device pinner Device pins allow enterprises to control what devices can use native Box applications. --- ## Device pinners *Type: resource | Category: api-resource* A list of device pins. # Device pinners A list of device pins. --- ## Download file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-content/ **Reference:** https://developer.box.com/reference/get-files-id-content/ --- ## Download zip archive *Type: endpoint | Category: api-endpoint* # undefined /reference/get-zip-downloads-id-content/ **Reference:** https://developer.box.com/reference/get-zip-downloads-id-content/ --- ## Email alias *Type: resource | Category: api-resource* An email alias for a user. # Email alias An email alias for a user. --- ## Email aliases *Type: resource | Category: api-resource* A list of email aliases. # Email aliases A list of email aliases. --- ## Enterprise (Base) *Type: resource | Category: api-resource* A mini representation of a enterprise, used when nested within another resource. # Enterprise (Base) A mini representation of a enterprise, used when nested within another resource. --- ## Event *Type: resource | Category: api-resource* The description of an event that happened within Box. # Event The description of an event that happened within Box. --- ## Event source *Type: resource | Category: api-resource* The source file or folder that triggered an event in the event stream. # Event source The source file or folder that triggered an event in the event stream. --- ## Events *Type: resource | Category: api-resource* A list of event objects. # Events A list of event objects. --- ## Extract metadata (freeform) *Type: endpoint | Category: api-endpoint* # undefined /reference/post-ai-extract/ **Reference:** https://developer.box.com/reference/post-ai-extract/ --- ## Extract metadata (structured) *Type: endpoint | Category: api-endpoint* # undefined /reference/post-ai-extract-structured/ **Reference:** https://developer.box.com/reference/post-ai-extract-structured/ --- ## File *Type: resource | Category: api-resource* A standard representation of a file, as returned from any file API endpoints by default. # File A standard representation of a file, as returned from any file API endpoints by default. --- ## File (Base) *Type: resource | Category: api-resource* The bare basic representation of a file, the minimal amount of fields returned when using the `fields` query parameter. # File (Base) The bare basic representation of a file, the minimal amount of fields returned when using the `fields` query parameter. --- ## File (Conflict) *Type: resource | Category: api-resource* A representation of a file that is used to show. # File (Conflict) A representation of a file that is used to show. --- ## File (Full) *Type: resource | Category: api-resource* A full representation of a file, as can be returned from any file API endpoints by default. # File (Full) A full representation of a file, as can be returned from any file API endpoints by default. --- ## File (Mini) *Type: resource | Category: api-resource* A mini representation of a file, used when nested under another resource. # File (Mini) A mini representation of a file, used when nested under another resource. --- ## File Request *Type: resource | Category: api-resource* A standard representation of a file request, as returned from any file request API endpoints by default. # File Request A standard representation of a file request, as returned from any file request API endpoints by default. --- ## File version *Type: resource | Category: api-resource* A standard representation of a file version. # File version A standard representation of a file version. --- ## File version (Base) *Type: resource | Category: api-resource* The bare basic representation of a file version, the minimal amount of fields returned when using the `fields` query parameter. # File version (Base) The bare basic representation of a file version, the minimal amount of fields returned when using the `fields` query parameter. --- ## File version (Full) *Type: resource | Category: api-resource* A full representation of a file version, as can be returned from any file version API endpoints by default. # File version (Full) A full representation of a file version, as can be returned from any file version API endpoints by default. --- ## File version (Mini) *Type: resource | Category: api-resource* A mini representation of a file version, used when nested within another resource. # File version (Mini) A mini representation of a file version, used when nested within another resource. --- ## File version legal hold *Type: resource | Category: api-resource* File version legal hold is an entity representing all holds on a File Version. # File version legal hold File version legal hold is an entity representing all holds on a File Version. --- ## File version legal holds *Type: resource | Category: api-resource* A list of file versions with legal holds. # File version legal holds A list of file versions with legal holds. --- ## File version retention *Type: resource | Category: api-resource* A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key in your application management console. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints. # File version retention A retention policy blocks permanent deletion of content for a specified amount of time. Admins can apply policies to specified folders, or an entire enterprise. A file version retention is a record for a retained file version. To use this feature, you must have the manage retention policies scope enabled for your API key in your application management console. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints. --- ## File version retentions *Type: resource | Category: api-resource* A list of file version retentions. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints. # File version retentions A list of file version retentions. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints. --- ## File versions *Type: resource | Category: api-resource* A list of file versions. # File versions A list of file versions. --- ## File versions on hold *Type: resource | Category: api-resource* A list of files on hold for legal policy assignment. # File versions on hold A list of files on hold for legal policy assignment. --- ## Files *Type: resource | Category: api-resource* A list of files. # Files A list of files. --- ## Files on hold *Type: resource | Category: api-resource* A list of files on hold for legal policy assignment. # Files on hold A list of files on hold for legal policy assignment. --- ## Files under retention *Type: resource | Category: api-resource* A list of files under retention. # Files under retention A list of files under retention. --- ## Find app item for shared link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shared-items--app-items/ **Reference:** https://developer.box.com/reference/get-shared-items--app-items/ --- ## Find file for shared link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shared-items/ **Reference:** https://developer.box.com/reference/get-shared-items/ --- ## Find folder for shared link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shared-items--folders/ **Reference:** https://developer.box.com/reference/get-shared-items--folders/ --- ## Find metadata template by instance ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-templates/ **Reference:** https://developer.box.com/reference/get-metadata-templates/ --- ## Find web link for shared link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shared-items--web-links/ **Reference:** https://developer.box.com/reference/get-shared-items--web-links/ --- ## Folder *Type: resource | Category: api-resource* A standard representation of a folder, as returned from any folder API endpoints by default. # Folder A standard representation of a folder, as returned from any folder API endpoints by default. --- ## Folder (Base) *Type: resource | Category: api-resource* The bare basic representation of a folder, the minimal amount of fields returned when using the `fields` query parameter. # Folder (Base) The bare basic representation of a folder, the minimal amount of fields returned when using the `fields` query parameter. --- ## Folder (Full) *Type: resource | Category: api-resource* A full representation of a folder, as can be returned from any folder API endpoints by default. # Folder (Full) A full representation of a folder, as can be returned from any folder API endpoints by default. --- ## Folder (Mini) *Type: resource | Category: api-resource* A mini representation of a file version, used when nested under another resource. # Folder (Mini) A mini representation of a file version, used when nested under another resource. --- ## Folder Lock *Type: resource | Category: api-resource* Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted. # Folder Lock Folder locks define access restrictions placed by folder owners to prevent specific folders from being moved or deleted. --- ## Folder Locks *Type: resource | Category: api-resource* A list of folder locks. # Folder Locks A list of folder locks. --- ## Force-apply metadata cascade policy to folder *Type: endpoint | Category: api-endpoint* # undefined /reference/post-metadata-cascade-policies-id-apply/ **Reference:** https://developer.box.com/reference/post-metadata-cascade-policies-id-apply/ --- ## Generate document using Box Doc Gen template *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-docgen-batches/ **Reference:** https://developer.box.com/reference/v2025.0/post-docgen-batches/ --- ## Generate text *Type: endpoint | Category: api-endpoint* # undefined /reference/post-ai-text-gen/ **Reference:** https://developer.box.com/reference/post-ai-text-gen/ --- ## Generic source *Type: resource | Category: api-resource* A generic event source type. # Generic source A generic event source type. --- ## Get AI agent by agent ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-ai-agents-id/ **Reference:** https://developer.box.com/reference/get-ai-agents-id/ --- ## Get AI agent default configuration *Type: endpoint | Category: api-endpoint* # undefined /reference/get-ai-agent-default/ **Reference:** https://developer.box.com/reference/get-ai-agent-default/ --- ## Get all shield lists in enterprise *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-shield-lists/ **Reference:** https://developer.box.com/reference/v2025.0/get-shield-lists/ --- ## Get allowed collaboration domain *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collaboration-whitelist-entries-id/ **Reference:** https://developer.box.com/reference/get-collaboration-whitelist-entries-id/ --- ## Get Box Doc Gen job by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-jobs-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-jobs-id/ --- ## Get Box Doc Gen jobs by batch ID *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-batch-jobs-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-batch-jobs-id/ --- ## Get Box Doc Gen template by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-templates-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-templates-id/ --- ## Get Box Sign request by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-sign-requests-id/ **Reference:** https://developer.box.com/reference/get-sign-requests-id/ --- ## Get Box Sign template by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-sign-templates-id/ **Reference:** https://developer.box.com/reference/get-sign-templates-id/ --- ## Get classification on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Get classification on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Get collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collaborations-id/ **Reference:** https://developer.box.com/reference/get-collaborations-id/ --- ## Get collection by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collections-id/ **Reference:** https://developer.box.com/reference/get-collections-id/ --- ## Get comment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-comments-id/ **Reference:** https://developer.box.com/reference/get-comments-id/ --- ## Get current user *Type: endpoint | Category: api-endpoint* # undefined /reference/get-users-me/ **Reference:** https://developer.box.com/reference/get-users-me/ --- ## Get device pin *Type: endpoint | Category: api-endpoint* # undefined /reference/get-device-pinners-id/ **Reference:** https://developer.box.com/reference/get-device-pinners-id/ --- ## Get events long poll endpoint *Type: endpoint | Category: api-endpoint* # undefined /reference/options-events/ **Reference:** https://developer.box.com/reference/options-events/ --- ## Get file information *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id/ **Reference:** https://developer.box.com/reference/get-files-id/ --- ## Get file request *Type: endpoint | Category: api-endpoint* # undefined /reference/get-file-requests-id/ **Reference:** https://developer.box.com/reference/get-file-requests-id/ --- ## Get file thumbnail *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-thumbnail-id/ **Reference:** https://developer.box.com/reference/get-files-id-thumbnail-id/ --- ## Get file version *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-versions-id/ **Reference:** https://developer.box.com/reference/get-files-id-versions-id/ --- ## Get file version legal hold *Type: endpoint | Category: api-endpoint* # undefined /reference/get-file-version-legal-holds-id/ **Reference:** https://developer.box.com/reference/get-file-version-legal-holds-id/ --- ## Get file versions under retention *Type: endpoint | Category: api-endpoint* # undefined /reference/get-retention-policy-assignments-id-file-versions-under-retention/ **Reference:** https://developer.box.com/reference/get-retention-policy-assignments-id-file-versions-under-retention/ --- ## Get files under retention *Type: endpoint | Category: api-endpoint* # undefined /reference/get-retention-policy-assignments-id-files-under-retention/ **Reference:** https://developer.box.com/reference/get-retention-policy-assignments-id-files-under-retention/ --- ## Get folder information *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id/ **Reference:** https://developer.box.com/reference/get-folders-id/ --- ## Get group *Type: endpoint | Category: api-endpoint* # undefined /reference/get-groups-id/ **Reference:** https://developer.box.com/reference/get-groups-id/ --- ## Get group membership *Type: endpoint | Category: api-endpoint* # undefined /reference/get-group-memberships-id/ **Reference:** https://developer.box.com/reference/get-group-memberships-id/ --- ## Get hub collaboration by collaboration ID *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-hub-collaborations-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-hub-collaborations-id/ --- ## Get hub collaborations *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-hub-collaborations/ **Reference:** https://developer.box.com/reference/v2025.0/get-hub-collaborations/ --- ## Get hub information by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-hubs-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-hubs-id/ --- ## Get hub items *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-hub-items/ **Reference:** https://developer.box.com/reference/v2025.0/get-hub-items/ --- ## Get legal hold policy *Type: endpoint | Category: api-endpoint* # undefined /reference/get-legal-hold-policies-id/ **Reference:** https://developer.box.com/reference/get-legal-hold-policies-id/ --- ## Get legal hold policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-legal-hold-policy-assignments-id/ **Reference:** https://developer.box.com/reference/get-legal-hold-policy-assignments-id/ --- ## Get list of all Box Doc Gen jobs for template *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-template-jobs-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-template-jobs-id/ --- ## Get metadata cascade policy *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-cascade-policies-id/ **Reference:** https://developer.box.com/reference/get-metadata-cascade-policies-id/ --- ## Get metadata instance on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/get-files-id-metadata-id-id/ --- ## Get metadata instance on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/get-folders-id-metadata-id-id/ --- ## Get metadata template by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-templates-id/ **Reference:** https://developer.box.com/reference/get-metadata-templates-id/ --- ## Get metadata template by name *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-templates-id-id-schema/ **Reference:** https://developer.box.com/reference/get-metadata-templates-id-id-schema/ --- ## Get retention on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-file-version-retentions-id/ **Reference:** https://developer.box.com/reference/get-file-version-retentions-id/ --- ## Get retention policy *Type: endpoint | Category: api-endpoint* # undefined /reference/get-retention-policies-id/ **Reference:** https://developer.box.com/reference/get-retention-policies-id/ --- ## Get retention policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-retention-policy-assignments-id/ **Reference:** https://developer.box.com/reference/get-retention-policy-assignments-id/ --- ## Get shared link for file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id--get-shared-link/ **Reference:** https://developer.box.com/reference/get-files-id--get-shared-link/ --- ## Get shared link for folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id--get-shared-link/ **Reference:** https://developer.box.com/reference/get-folders-id--get-shared-link/ --- ## Get shared link for web link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-web-links-id--get-shared-link/ **Reference:** https://developer.box.com/reference/get-web-links-id--get-shared-link/ --- ## Get shield information barrier report by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-reports-id/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-reports-id/ --- ## Get shield information barrier segment member by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-segment-members-id/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-segment-members-id/ --- ## Get shield information barrier segment restriction by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-segment-restrictions-id/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions-id/ --- ## Get shield information barrier segment with specified ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-segments-id/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-segments-id/ --- ## Get shield information barrier with specified ID *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barriers-id/ **Reference:** https://developer.box.com/reference/get-shield-information-barriers-id/ --- ## Get single shield list by shield list id *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-shield-lists-id/ **Reference:** https://developer.box.com/reference/v2025.0/get-shield-lists-id/ --- ## Get storage policy *Type: endpoint | Category: api-endpoint* # undefined /reference/get-storage-policies-id/ **Reference:** https://developer.box.com/reference/get-storage-policies-id/ --- ## Get storage policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-storage-policy-assignments-id/ **Reference:** https://developer.box.com/reference/get-storage-policy-assignments-id/ --- ## Get task *Type: endpoint | Category: api-endpoint* # undefined /reference/get-tasks-id/ **Reference:** https://developer.box.com/reference/get-tasks-id/ --- ## Get task assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-task-assignments-id/ **Reference:** https://developer.box.com/reference/get-task-assignments-id/ --- ## Get terms of service *Type: endpoint | Category: api-endpoint* # undefined /reference/get-terms-of-services-id/ **Reference:** https://developer.box.com/reference/get-terms-of-services-id/ --- ## Get trashed file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-trash/ **Reference:** https://developer.box.com/reference/get-files-id-trash/ --- ## Get trashed folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-trash/ **Reference:** https://developer.box.com/reference/get-folders-id-trash/ --- ## Get trashed web link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-web-links-id-trash/ **Reference:** https://developer.box.com/reference/get-web-links-id-trash/ --- ## Get upload session *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-upload-sessions-id/ **Reference:** https://developer.box.com/reference/get-files-upload-sessions-id/ --- ## Get user *Type: endpoint | Category: api-endpoint* # undefined /reference/get-users-id/ **Reference:** https://developer.box.com/reference/get-users-id/ --- ## Get user avatar *Type: endpoint | Category: api-endpoint* # undefined /reference/get-users-id-avatar/ **Reference:** https://developer.box.com/reference/get-users-id-avatar/ --- ## Get user exempt from collaboration domain restrictions *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collaboration-whitelist-exempt-targets-id/ **Reference:** https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets-id/ --- ## Get user invite status *Type: endpoint | Category: api-endpoint* # undefined /reference/get-invites-id/ **Reference:** https://developer.box.com/reference/get-invites-id/ --- ## Get watermark for folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-watermark/ **Reference:** https://developer.box.com/reference/get-folders-id-watermark/ --- ## Get watermark on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-watermark/ **Reference:** https://developer.box.com/reference/get-files-id-watermark/ --- ## Get web link *Type: endpoint | Category: api-endpoint* # undefined /reference/get-web-links-id/ **Reference:** https://developer.box.com/reference/get-web-links-id/ --- ## Get webhook *Type: endpoint | Category: api-endpoint* # undefined /reference/get-webhooks-id/ **Reference:** https://developer.box.com/reference/get-webhooks-id/ --- ## Get zip download status *Type: endpoint | Category: api-endpoint* # undefined /reference/get-zip-downloads-id-status/ **Reference:** https://developer.box.com/reference/get-zip-downloads-id-status/ --- ## Group *Type: resource | Category: api-resource* A standard representation of a group, as returned from any group API endpoints by default. # Group A standard representation of a group, as returned from any group API endpoints by default. --- ## Group (Base) *Type: resource | Category: api-resource* A base representation of a group. # Group (Base) A base representation of a group. --- ## Group (Full) *Type: resource | Category: api-resource* Groups contain a set of users, and can be used in place of users in some operations, such as collaborations. # Group (Full) Groups contain a set of users, and can be used in place of users in some operations, such as collaborations. --- ## Group (Mini) *Type: resource | Category: api-resource* Mini representation of a group, including id and name of group. # Group (Mini) Mini representation of a group, including id and name of group. --- ## Group membership *Type: resource | Category: api-resource* Membership is used to signify that a user is part of a group. # Group membership Membership is used to signify that a user is part of a group. --- ## Group memberships *Type: resource | Category: api-resource* A list of group memberships. # Group memberships A list of group memberships. --- ## Groups *Type: resource | Category: api-resource* A list of groups. # Groups A list of groups. --- ## Hub *Type: resource | Category: api-resource* A standard representation of a hub, as returned from any hubs API endpoints by default. # Hub A standard representation of a hub, as returned from any hubs API endpoints by default. --- ## Hub (Base) *Type: resource | Category: api-resource* The bare basic representation of a hub. # Hub (Base) The bare basic representation of a hub. --- ## Hub Collaboration *Type: resource | Category: api-resource* A hub collaboration object grants a user or group access to a hub with permissions defined by a specific role. # Hub Collaboration A hub collaboration object grants a user or group access to a hub with permissions defined by a specific role. --- ## Hub Collaborations *Type: resource | Category: api-resource* A list of hub collaborations. # Hub Collaborations A list of hub collaborations. --- ## Hub Item *Type: resource | Category: api-resource* A Hub Item is a Box Item that is referenced in a Hub. # Hub Item A Hub Item is a Box Item that is referenced in a Hub. --- ## Hub Items *Type: resource | Category: api-resource* A list of Hub items. # Hub Items A list of Hub items. --- ## Hub Items Manage Response *Type: resource | Category: api-resource* Response schema for the status of Hub items management operations. # Hub Items Manage Response Response schema for the status of Hub items management operations. --- ## Hubs *Type: resource | Category: api-resource* A paginated list of hubs. # Hubs A paginated list of hubs. --- ## Integration mapping Slack *Type: resource | Category: api-resource* A Slack specific representation of an integration mapping object. # Integration mapping Slack A Slack specific representation of an integration mapping object. --- ## Integration mapping Teams *Type: resource | Category: api-resource* A Microsoft Teams specific representation of an integration mapping object. # Integration mapping Teams A Microsoft Teams specific representation of an integration mapping object. --- ## Integration mappings Slack *Type: resource | Category: api-resource* A list of integration mapping objects. # Integration mappings Slack A list of integration mapping objects. --- ## Integration mappings Teams *Type: resource | Category: api-resource* A list of integration mapping objects. # Integration mappings Teams A list of integration mapping objects. --- ## Invite *Type: resource | Category: api-resource* An invite for a user to an enterprise. # Invite An invite for a user to an enterprise. --- ## Items *Type: resource | Category: api-resource* A list of files, folders, and web links in their mini representation. # Items A list of files, folders, and web links in their mini representation. --- ## Items *Type: resource | Category: api-resource* A list of files, folders, and web links in their mini representation. # Items A list of files, folders, and web links in their mini representation. --- ## Keyword Skill Card *Type: resource | Category: api-resource* A skill card that contains a set of keywords. # Keyword Skill Card A skill card that contains a set of keywords. --- ## Legal hold policies *Type: resource | Category: api-resource* A list of legal hold policies. # Legal hold policies A list of legal hold policies. --- ## Legal hold policy *Type: resource | Category: api-resource* Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter dates. # Legal hold policy Legal Hold Policy information describes the basic characteristics of the Policy, such as name, description, and filter dates. --- ## Legal hold policy (Mini) *Type: resource | Category: api-resource* A mini legal hold policy. # Legal hold policy (Mini) A mini legal hold policy. --- ## Legal hold policy assignment *Type: resource | Category: api-resource* Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity. # Legal hold policy assignment Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity. --- ## Legal hold policy assignment (Base) *Type: resource | Category: api-resource* Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity. # Legal hold policy assignment (Base) Legal Hold Assignments are used to assign Legal Hold Policies to Users, Folders, Files, or File Versions. Creating a Legal Hold Assignment puts a hold on the File-Versions that belong to the Assignment's 'apply-to' entity. --- ## Legal hold policy assignments *Type: resource | Category: api-resource* A list of legal hold policies assignments. # Legal hold policy assignments A list of legal hold policies assignments. --- ## List AI agents *Type: endpoint | Category: api-endpoint* # undefined /reference/get-ai-agents/ **Reference:** https://developer.box.com/reference/get-ai-agents/ --- ## List all Box Doc Gen jobs *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-jobs/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-jobs/ --- ## List all Box Doc Gen template tags in template *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-templates-id-tags/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-templates-id-tags/ --- ## List all classifications *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema/ **Reference:** https://developer.box.com/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema/ --- ## List all collections *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collections/ **Reference:** https://developer.box.com/reference/get-collections/ --- ## List all file versions *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-versions/ **Reference:** https://developer.box.com/reference/get-files-id-versions/ --- ## List all global metadata templates *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-templates-global/ **Reference:** https://developer.box.com/reference/get-metadata-templates-global/ --- ## List all hubs *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-hubs/ **Reference:** https://developer.box.com/reference/v2025.0/get-hubs/ --- ## List all hubs for requesting enterprise *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-enterprise-hubs/ **Reference:** https://developer.box.com/reference/v2025.0/get-enterprise-hubs/ --- ## List all legal hold policies *Type: endpoint | Category: api-endpoint* # undefined /reference/get-legal-hold-policies/ **Reference:** https://developer.box.com/reference/get-legal-hold-policies/ --- ## List all metadata templates for enterprise *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-templates-enterprise/ **Reference:** https://developer.box.com/reference/get-metadata-templates-enterprise/ --- ## List all webhooks *Type: endpoint | Category: api-endpoint* # undefined /reference/get-webhooks/ **Reference:** https://developer.box.com/reference/get-webhooks/ --- ## List allowed collaboration domains *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collaboration-whitelist-entries/ **Reference:** https://developer.box.com/reference/get-collaboration-whitelist-entries/ --- ## List archives *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-archives/ **Reference:** https://developer.box.com/reference/v2025.0/get-archives/ --- ## List Box Doc Gen templates *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/get-docgen-templates/ **Reference:** https://developer.box.com/reference/v2025.0/get-docgen-templates/ --- ## List Box Sign requests *Type: endpoint | Category: api-endpoint* # undefined /reference/get-sign-requests/ **Reference:** https://developer.box.com/reference/get-sign-requests/ --- ## List Box Sign templates *Type: endpoint | Category: api-endpoint* # undefined /reference/get-sign-templates/ **Reference:** https://developer.box.com/reference/get-sign-templates/ --- ## List Box Skill cards on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-metadata-global-boxSkillsCards/ **Reference:** https://developer.box.com/reference/get-files-id-metadata-global-boxSkillsCards/ --- ## List collection items *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collections-id-items/ **Reference:** https://developer.box.com/reference/get-collections-id-items/ --- ## List enterprise device pins *Type: endpoint | Category: api-endpoint* # undefined /reference/get-enterprises-id-device-pinners/ **Reference:** https://developer.box.com/reference/get-enterprises-id-device-pinners/ --- ## List enterprise users *Type: endpoint | Category: api-endpoint* # undefined /reference/get-users/ **Reference:** https://developer.box.com/reference/get-users/ --- ## List file app item associations *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-app-item-associations/ **Reference:** https://developer.box.com/reference/get-files-id-app-item-associations/ --- ## List file collaborations *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-collaborations/ **Reference:** https://developer.box.com/reference/get-files-id-collaborations/ --- ## List file comments *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-comments/ **Reference:** https://developer.box.com/reference/get-files-id-comments/ --- ## List file version legal holds *Type: endpoint | Category: api-endpoint* # undefined /reference/get-file-version-legal-holds/ **Reference:** https://developer.box.com/reference/get-file-version-legal-holds/ --- ## List file version retentions *Type: endpoint | Category: api-endpoint* # undefined /reference/get-file-version-retentions/ **Reference:** https://developer.box.com/reference/get-file-version-retentions/ --- ## List files with current file versions for legal hold policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-legal-hold-policy-assignments-id-files-on-hold/ **Reference:** https://developer.box.com/reference/get-legal-hold-policy-assignments-id-files-on-hold/ --- ## List folder app item associations *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-app-item-associations/ **Reference:** https://developer.box.com/reference/get-folders-id-app-item-associations/ --- ## List folder collaborations *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-collaborations/ **Reference:** https://developer.box.com/reference/get-folders-id-collaborations/ --- ## List folder locks *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folder-locks/ **Reference:** https://developer.box.com/reference/get-folder-locks/ --- ## List group collaborations *Type: endpoint | Category: api-endpoint* # undefined /reference/get-groups-id-collaborations/ **Reference:** https://developer.box.com/reference/get-groups-id-collaborations/ --- ## List groups for enterprise *Type: endpoint | Category: api-endpoint* # undefined /reference/get-groups/ **Reference:** https://developer.box.com/reference/get-groups/ --- ## List items in folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-items/ **Reference:** https://developer.box.com/reference/get-folders-id-items/ --- ## List legal hold policy assignments *Type: endpoint | Category: api-endpoint* # undefined /reference/get-legal-hold-policy-assignments/ **Reference:** https://developer.box.com/reference/get-legal-hold-policy-assignments/ --- ## List members of group *Type: endpoint | Category: api-endpoint* # undefined /reference/get-groups-id-memberships/ **Reference:** https://developer.box.com/reference/get-groups-id-memberships/ --- ## List metadata cascade policies *Type: endpoint | Category: api-endpoint* # undefined /reference/get-metadata-cascade-policies/ **Reference:** https://developer.box.com/reference/get-metadata-cascade-policies/ --- ## List metadata instances on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-metadata/ **Reference:** https://developer.box.com/reference/get-files-id-metadata/ --- ## List metadata instances on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-id-metadata/ **Reference:** https://developer.box.com/reference/get-folders-id-metadata/ --- ## List of Shield Information Barrier Reports *Type: resource | Category: api-resource* A list of shield barrier reports. # List of Shield Information Barrier Reports A list of shield barrier reports. --- ## List of Shield Information Barrier Segment Members *Type: resource | Category: api-resource* List of Shield Information Barrier Member objects. # List of Shield Information Barrier Segment Members List of Shield Information Barrier Member objects. --- ## List of Shield Information Barrier Segment Restrictions *Type: resource | Category: api-resource* List of shield information barrier segment restriction objects. # List of Shield Information Barrier Segment Restrictions List of shield information barrier segment restriction objects. --- ## List of Shield Information Barrier Segments *Type: resource | Category: api-resource* List of Shield Information Barrier Segment objects. # List of Shield Information Barrier Segments List of Shield Information Barrier Segment objects. --- ## List of Shield Information Barriers *Type: resource | Category: api-resource* List of Shield Information Barrier objects. # List of Shield Information Barriers List of Shield Information Barrier objects. --- ## List of Shield Lists *Type: resource | Category: api-resource* List of Shield List objects. # List of Shield Lists List of Shield List objects. --- ## List parts *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-upload-sessions-id-parts/ **Reference:** https://developer.box.com/reference/get-files-upload-sessions-id-parts/ --- ## List pending collaborations *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collaborations/ **Reference:** https://developer.box.com/reference/get-collaborations/ --- ## List previous file versions for legal hold policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/get-legal-hold-policy-assignments-id-file-versions-on-hold/ **Reference:** https://developer.box.com/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold/ --- ## List recently accessed items *Type: endpoint | Category: api-endpoint* # undefined /reference/get-recent-items/ **Reference:** https://developer.box.com/reference/get-recent-items/ --- ## List retention policies *Type: endpoint | Category: api-endpoint* # undefined /reference/get-retention-policies/ **Reference:** https://developer.box.com/reference/get-retention-policies/ --- ## List retention policy assignments *Type: endpoint | Category: api-endpoint* # undefined /reference/get-retention-policies-id-assignments/ **Reference:** https://developer.box.com/reference/get-retention-policies-id-assignments/ --- ## List shield information barrier reports *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-reports/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-reports/ --- ## List shield information barrier segment members *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-segment-members/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-segment-members/ --- ## List shield information barrier segment restrictions *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-segment-restrictions/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-segment-restrictions/ --- ## List shield information barrier segments *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barrier-segments/ **Reference:** https://developer.box.com/reference/get-shield-information-barrier-segments/ --- ## List shield information barriers *Type: endpoint | Category: api-endpoint* # undefined /reference/get-shield-information-barriers/ **Reference:** https://developer.box.com/reference/get-shield-information-barriers/ --- ## List Slack integration mappings *Type: endpoint | Category: api-endpoint* # undefined /reference/get-integration-mappings-slack/ **Reference:** https://developer.box.com/reference/get-integration-mappings-slack/ --- ## List storage policies *Type: endpoint | Category: api-endpoint* # undefined /reference/get-storage-policies/ **Reference:** https://developer.box.com/reference/get-storage-policies/ --- ## List storage policy assignments *Type: endpoint | Category: api-endpoint* # undefined /reference/get-storage-policy-assignments/ **Reference:** https://developer.box.com/reference/get-storage-policy-assignments/ --- ## List task assignments *Type: endpoint | Category: api-endpoint* # undefined /reference/get-tasks-id-assignments/ **Reference:** https://developer.box.com/reference/get-tasks-id-assignments/ --- ## List tasks on file *Type: endpoint | Category: api-endpoint* # undefined /reference/get-files-id-tasks/ **Reference:** https://developer.box.com/reference/get-files-id-tasks/ --- ## List Teams integration mappings *Type: endpoint | Category: api-endpoint* # undefined /reference/get-integration-mappings-teams/ **Reference:** https://developer.box.com/reference/get-integration-mappings-teams/ --- ## List terms of service user statuses *Type: endpoint | Category: api-endpoint* # undefined /reference/get-terms-of-service-user-statuses/ **Reference:** https://developer.box.com/reference/get-terms-of-service-user-statuses/ --- ## List terms of services *Type: endpoint | Category: api-endpoint* # undefined /reference/get-terms-of-services/ **Reference:** https://developer.box.com/reference/get-terms-of-services/ --- ## List trashed items *Type: endpoint | Category: api-endpoint* # undefined /reference/get-folders-trash-items/ **Reference:** https://developer.box.com/reference/get-folders-trash-items/ --- ## List user and enterprise events *Type: endpoint | Category: api-endpoint* # undefined /reference/get-events/ **Reference:** https://developer.box.com/reference/get-events/ --- ## List user's email aliases *Type: endpoint | Category: api-endpoint* # undefined /reference/get-users-id-email-aliases/ **Reference:** https://developer.box.com/reference/get-users-id-email-aliases/ --- ## List user's groups *Type: endpoint | Category: api-endpoint* # undefined /reference/get-users-id-memberships/ **Reference:** https://developer.box.com/reference/get-users-id-memberships/ --- ## List users exempt from collaboration domain restrictions *Type: endpoint | Category: api-endpoint* # undefined /reference/get-collaboration-whitelist-exempt-targets/ **Reference:** https://developer.box.com/reference/get-collaboration-whitelist-exempt-targets/ --- ## List workflows *Type: endpoint | Category: api-endpoint* # undefined /reference/get-workflows/ **Reference:** https://developer.box.com/reference/get-workflows/ --- ## Manage hub items *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/post-hubs-id-manage-items/ **Reference:** https://developer.box.com/reference/v2025.0/post-hubs-id-manage-items/ --- ## Metadata cascade policies *Type: resource | Category: api-resource* A list of metadata cascade policies. # Metadata cascade policies A list of metadata cascade policies. --- ## Metadata cascade policy *Type: resource | Category: api-resource* A metadata cascade policy automatically applies a metadata template instance to all the files and folders within the targeted folder. # Metadata cascade policy A metadata cascade policy automatically applies a metadata template instance to all the files and folders within the targeted folder. --- ## Metadata Error *Type: resource | Category: api-resource* A generic metadata operation error. # Metadata Error A generic metadata operation error. --- ## Metadata field filter (date range) *Type: resource | Category: api-resource* Specifies which `date` field on the template to filter the search results by, specifying a range of dates that can match. # Metadata field filter (date range) Specifies which `date` field on the template to filter the search results by, specifying a range of dates that can match. --- ## Metadata field filter (float range) *Type: resource | Category: api-resource* Specifies which `float` field on the template to filter the search results by, specifying a range of values that can match. # Metadata field filter (float range) Specifies which `float` field on the template to filter the search results by, specifying a range of values that can match. --- ## Metadata filter *Type: resource | Category: api-resource* A metadata template used to filter the search results. # Metadata filter A metadata template used to filter the search results. --- ## Metadata instance *Type: resource | Category: api-resource* An instance of a metadata template, which has been applied to a file or folder. # Metadata instance An instance of a metadata template, which has been applied to a file or folder. --- ## Metadata instance (Base) *Type: resource | Category: api-resource* The base representation of a metadata instance. # Metadata instance (Base) The base representation of a metadata instance. --- ## Metadata instance (Full) *Type: resource | Category: api-resource* An instance of a metadata template, which has been applied to a file or folder. # Metadata instance (Full) An instance of a metadata template, which has been applied to a file or folder. --- ## Metadata instances *Type: resource | Category: api-resource* A list of metadata instances that have been applied to a file or folder. # Metadata instances A list of metadata instances that have been applied to a file or folder. --- ## Metadata query index *Type: resource | Category: api-resource* A metadata query index. # Metadata query index A metadata query index. --- ## Metadata query search results *Type: resource | Category: api-resource* A page of files and folders that matched the metadata query. # Metadata query search results A page of files and folders that matched the metadata query. --- ## Metadata template *Type: resource | Category: api-resource* A template for metadata that can be applied to files and folders. # Metadata template A template for metadata that can be applied to files and folders. --- ## Metadata templates *Type: resource | Category: api-resource* A list of metadata templates. # Metadata templates A list of metadata templates. --- ## OAuth 2.0 error *Type: resource | Category: api-resource* An OAuth 2.0 error. # OAuth 2.0 error An OAuth 2.0 error. --- ## Permanently remove file *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id-trash/ **Reference:** https://developer.box.com/reference/delete-files-id-trash/ --- ## Permanently remove folder *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-folders-id-trash/ **Reference:** https://developer.box.com/reference/delete-folders-id-trash/ --- ## Permanently remove web link *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-web-links-id-trash/ **Reference:** https://developer.box.com/reference/delete-web-links-id-trash/ --- ## Preflight check before upload *Type: endpoint | Category: api-endpoint* # undefined /reference/options-files-content/ **Reference:** https://developer.box.com/reference/options-files-content/ --- ## Promote file version *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-versions-current/ **Reference:** https://developer.box.com/reference/post-files-id-versions-current/ --- ## Query files/folders by metadata *Type: endpoint | Category: api-endpoint* # undefined /reference/post-metadata-queries-execute-read/ **Reference:** https://developer.box.com/reference/post-metadata-queries-execute-read/ --- ## Real-time server *Type: resource | Category: api-resource* A real-time server that can be used for long polling user events. # Real-time server A real-time server that can be used for long polling user events. --- ## Real-time servers *Type: resource | Category: api-resource* A list of real-time servers that can be used for long-polling. # Real-time servers A list of real-time servers that can be used for long-polling. --- ## Recent item *Type: resource | Category: api-resource* A recent item accessed by a user. # Recent item A recent item accessed by a user. --- ## Recent items *Type: resource | Category: api-resource* A list of recent items. # Recent items A list of recent items. --- ## Refresh access token *Type: endpoint | Category: api-endpoint* # undefined /reference/post-oauth2-token--refresh/ **Reference:** https://developer.box.com/reference/post-oauth2-token--refresh/ --- ## Remove Box Skill cards from file *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id-metadata-global-boxSkillsCards/ **Reference:** https://developer.box.com/reference/delete-files-id-metadata-global-boxSkillsCards/ --- ## Remove classification from file *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Remove classification from folder *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Remove collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-collaborations-id/ **Reference:** https://developer.box.com/reference/delete-collaborations-id/ --- ## Remove comment *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-comments-id/ **Reference:** https://developer.box.com/reference/delete-comments-id/ --- ## Remove device pin *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-device-pinners-id/ **Reference:** https://developer.box.com/reference/delete-device-pinners-id/ --- ## Remove domain from list of allowed collaboration domains *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-collaboration-whitelist-entries-id/ **Reference:** https://developer.box.com/reference/delete-collaboration-whitelist-entries-id/ --- ## Remove email alias *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-users-id-email-aliases-id/ **Reference:** https://developer.box.com/reference/delete-users-id-email-aliases-id/ --- ## Remove file version *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id-versions-id/ **Reference:** https://developer.box.com/reference/delete-files-id-versions-id/ --- ## Remove group *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-groups-id/ **Reference:** https://developer.box.com/reference/delete-groups-id/ --- ## Remove hub collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/delete-hub-collaborations-id/ **Reference:** https://developer.box.com/reference/v2025.0/delete-hub-collaborations-id/ --- ## Remove legal hold policy *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-legal-hold-policies-id/ **Reference:** https://developer.box.com/reference/delete-legal-hold-policies-id/ --- ## Remove metadata cascade policy *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-metadata-cascade-policies-id/ **Reference:** https://developer.box.com/reference/delete-metadata-cascade-policies-id/ --- ## Remove metadata instance from file *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/delete-files-id-metadata-id-id/ --- ## Remove metadata instance from folder *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-folders-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/delete-folders-id-metadata-id-id/ --- ## Remove metadata template *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-metadata-templates-id-id-schema/ **Reference:** https://developer.box.com/reference/delete-metadata-templates-id-id-schema/ --- ## Remove retention policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-retention-policy-assignments-id/ **Reference:** https://developer.box.com/reference/delete-retention-policy-assignments-id/ --- ## Remove shared link from file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id--remove-shared-link/ **Reference:** https://developer.box.com/reference/put-files-id--remove-shared-link/ --- ## Remove shared link from folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id--remove-shared-link/ **Reference:** https://developer.box.com/reference/put-folders-id--remove-shared-link/ --- ## Remove shared link from web link *Type: endpoint | Category: api-endpoint* # undefined /reference/put-web-links-id--remove-shared-link/ **Reference:** https://developer.box.com/reference/put-web-links-id--remove-shared-link/ --- ## Remove task *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-tasks-id/ **Reference:** https://developer.box.com/reference/delete-tasks-id/ --- ## Remove upload session *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-upload-sessions-id/ **Reference:** https://developer.box.com/reference/delete-files-upload-sessions-id/ --- ## Remove user from group *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-group-memberships-id/ **Reference:** https://developer.box.com/reference/delete-group-memberships-id/ --- ## Remove user from list of users exempt from domain restrictions *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-collaboration-whitelist-exempt-targets-id/ **Reference:** https://developer.box.com/reference/delete-collaboration-whitelist-exempt-targets-id/ --- ## Remove watermark from file *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-files-id-watermark/ **Reference:** https://developer.box.com/reference/delete-files-id-watermark/ --- ## Remove watermark from folder *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-folders-id-watermark/ **Reference:** https://developer.box.com/reference/delete-folders-id-watermark/ --- ## Remove web link *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-web-links-id/ **Reference:** https://developer.box.com/reference/delete-web-links-id/ --- ## Remove webhook *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-webhooks-id/ **Reference:** https://developer.box.com/reference/delete-webhooks-id/ --- ## Request access token *Type: endpoint | Category: api-endpoint* # undefined /reference/post-oauth2-token/ **Reference:** https://developer.box.com/reference/post-oauth2-token/ --- ## Resend Box Sign request *Type: endpoint | Category: api-endpoint* # undefined /reference/post-sign-requests-id-resend/ **Reference:** https://developer.box.com/reference/post-sign-requests-id-resend/ --- ## Restore file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id/ **Reference:** https://developer.box.com/reference/post-files-id/ --- ## Restore file version *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id-versions-id/ **Reference:** https://developer.box.com/reference/put-files-id-versions-id/ --- ## Restore folder *Type: endpoint | Category: api-endpoint* # undefined /reference/post-folders-id/ **Reference:** https://developer.box.com/reference/post-folders-id/ --- ## Restore web link *Type: endpoint | Category: api-endpoint* # undefined /reference/post-web-links-id/ **Reference:** https://developer.box.com/reference/post-web-links-id/ --- ## Retention policies *Type: resource | Category: api-resource* A list of retention policies. # Retention policies A list of retention policies. --- ## Retention policy *Type: resource | Category: api-resource* A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention policies and then later assign them to specific folders, metadata templates, or their entire enterprise. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. # Retention policy A retention policy blocks permanent deletion of content for a specified amount of time. Admins can create retention policies and then later assign them to specific folders, metadata templates, or their entire enterprise. To use this feature, you must have the manage retention policies scope enabled for your API key via your application management console. --- ## Retention policy (Base) *Type: resource | Category: api-resource* A base representation of a retention policy. # Retention policy (Base) A base representation of a retention policy. --- ## Retention policy (Mini) *Type: resource | Category: api-resource* A mini representation of a retention policy, used when nested within another resource. # Retention policy (Mini) A mini representation of a retention policy, used when nested within another resource. --- ## Retention policy assignment *Type: resource | Category: api-resource* A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or hold all files in the enterprise. # Retention policy assignment A retention assignment represents a rule specifying the files a retention policy retains. Assignments can retain files based on their folder or metadata, or hold all files in the enterprise. --- ## Retention policy assignment (Base) *Type: resource | Category: api-resource* A base representation of a retention policy assignment. # Retention policy assignment (Base) A base representation of a retention policy assignment. --- ## Retention policy assignments *Type: resource | Category: api-resource* A list of retention policy assignments. # Retention policy assignments A list of retention policy assignments. --- ## Revoke access token *Type: endpoint | Category: api-endpoint* # undefined /reference/post-oauth2-revoke/ **Reference:** https://developer.box.com/reference/post-oauth2-revoke/ --- ## Search for content *Type: endpoint | Category: api-endpoint* # undefined /reference/get-search/ **Reference:** https://developer.box.com/reference/get-search/ --- ## Search Result (including Shared Link) *Type: resource | Category: api-resource* A single of files, folder or web link that matched the search query, including the additional information about the shared link through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`. # Search Result (including Shared Link) A single of files, folder or web link that matched the search query, including the additional information about the shared link through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`. --- ## Search Results *Type: resource | Category: api-resource* A list of files, folders and web links that matched the search query. # Search Results A list of files, folders and web links that matched the search query. --- ## Search Results (including Shared Links) *Type: resource | Category: api-resource* A list of files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`. # Search Results (including Shared Links) A list of files, folders and web links that matched the search query, including the additional information about any shared links through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`. --- ## Session termination message *Type: resource | Category: api-resource* A message informing about the termination job status. # Session termination message A message informing about the termination job status. --- ## Shield information barrier *Type: resource | Category: api-resource* A standard representation of a shield information barrier object. # Shield information barrier A standard representation of a shield information barrier object. --- ## Shield information barrier (Base) *Type: resource | Category: api-resource* A base representation of a shield information barrier object. # Shield information barrier (Base) A base representation of a shield information barrier object. --- ## Shield information barrier reference *Type: resource | Category: api-resource* A shield information barrier reference for requests and responses. # Shield information barrier reference A shield information barrier reference for requests and responses. --- ## Shield information barrier report *Type: resource | Category: api-resource* A standard representation of a shield information barrier report object. # Shield information barrier report A standard representation of a shield information barrier report object. --- ## Shield information barrier report (Base) *Type: resource | Category: api-resource* A base representation of a shield information barrier report object. # Shield information barrier report (Base) A base representation of a shield information barrier report object. --- ## Shield information barrier report details *Type: resource | Category: api-resource* Indicates which folder the report file is located and any errors when generating the report. # Shield information barrier report details Indicates which folder the report file is located and any errors when generating the report. --- ## Shield information barrier segment *Type: resource | Category: api-resource* A shield information barrier segment object. # Shield information barrier segment A shield information barrier segment object. --- ## Shield information barrier segment member *Type: resource | Category: api-resource* A standard representation of a shield information barrier segment member object. # Shield information barrier segment member A standard representation of a shield information barrier segment member object. --- ## Shield information barrier segment member (Base) *Type: resource | Category: api-resource* A base representation of a shield information barrier segment member object. # Shield information barrier segment member (Base) A base representation of a shield information barrier segment member object. --- ## Shield information barrier segment member (Mini) *Type: resource | Category: api-resource* A mini representation of a shield information barrier segment member object. # Shield information barrier segment member (Mini) A mini representation of a shield information barrier segment member object. --- ## Shield information barrier segment restriction *Type: resource | Category: api-resource* A standard representation of a segment restriction of a shield information barrier object. # Shield information barrier segment restriction A standard representation of a segment restriction of a shield information barrier object. --- ## Shield information barrier segment restriction (Base) *Type: resource | Category: api-resource* A base representation of a segment restriction object for the shield information barrier. # Shield information barrier segment restriction (Base) A base representation of a segment restriction object for the shield information barrier. --- ## Shield information barrier segment restriction (Mini) *Type: resource | Category: api-resource* A mini representation of a segment restriction object for the shield information barrier. # Shield information barrier segment restriction (Mini) A mini representation of a segment restriction object for the shield information barrier. --- ## Shield List *Type: resource | Category: api-resource* A standard representation of a Shield List. # Shield List A standard representation of a Shield List. --- ## Shield List (Mini) *Type: resource | Category: api-resource* A mini representation of a Shield List. # Shield List (Mini) A mini representation of a Shield List. --- ## Shield List Content (Country) *Type: resource | Category: api-resource* Representation of content of a Shield List that contains countries data. # Shield List Content (Country) Representation of content of a Shield List that contains countries data. --- ## Shield List Content (Domain) *Type: resource | Category: api-resource* Representation of content of a Shield List that contains domains data. # Shield List Content (Domain) Representation of content of a Shield List that contains domains data. --- ## Shield List Content (Email) *Type: resource | Category: api-resource* Representation of content of a Shield List that contains email addresses data. # Shield List Content (Email) Representation of content of a Shield List that contains email addresses data. --- ## Shield List Content (Integration) *Type: resource | Category: api-resource* Representation of content of a Shield List that contains integrations data. # Shield List Content (Integration) Representation of content of a Shield List that contains integrations data. --- ## Shield List Content (IP) *Type: resource | Category: api-resource* Representation of content of a Shield List that contains ip addresses data. # Shield List Content (IP) Representation of content of a Shield List that contains ip addresses data. --- ## Skill webhook payload *Type: resource | Category: api-resource* The payload of a Box skill as sent to a skill's `invocation_url`. # Skill webhook payload The payload of a Box skill as sent to a skill's `invocation_url`. --- ## Skills metadata instance *Type: resource | Category: api-resource* The metadata assigned to a using for Box skills. # Skills metadata instance The metadata assigned to a using for Box skills. --- ## Starts workflow based on request body *Type: endpoint | Category: api-endpoint* # undefined /reference/post-workflows-id-start/ **Reference:** https://developer.box.com/reference/post-workflows-id-start/ --- ## Status Skill Card *Type: resource | Category: api-resource* A Box Skill metadata card that puts a status message in the metadata sidebar. # Status Skill Card A Box Skill metadata card that puts a status message in the metadata sidebar. --- ## Storage policies *Type: resource | Category: api-resource* A list of storage policies. # Storage policies A list of storage policies. --- ## Storage policy *Type: resource | Category: api-resource* The Storage Policy object describes the storage zone. # Storage policy The Storage Policy object describes the storage zone. --- ## Storage policy (Mini) *Type: resource | Category: api-resource* A mini description of a Storage Policy object. # Storage policy (Mini) A mini description of a Storage Policy object. --- ## Storage policy assignment *Type: resource | Category: api-resource* The assignment of a storage policy to a user or enterprise. # Storage policy assignment The assignment of a storage policy to a user or enterprise. --- ## Storage policy assignments *Type: resource | Category: api-resource* A list of storage policy assignments. # Storage policy assignments A list of storage policy assignments. --- ## Task *Type: resource | Category: api-resource* A task allows for file-centric workflows within Box. Users can create tasks on files and assign them to other users for them to complete the tasks. # Task A task allows for file-centric workflows within Box. Users can create tasks on files and assign them to other users for them to complete the tasks. --- ## Task assignment *Type: resource | Category: api-resource* A task assignment defines which task is assigned to which user to complete. # Task assignment A task assignment defines which task is assigned to which user to complete. --- ## Task assignments *Type: resource | Category: api-resource* A list of task assignments. # Task assignments A list of task assignments. --- ## Tasks *Type: resource | Category: api-resource* A list of tasks. # Tasks A list of tasks. --- ## Terms of service *Type: resource | Category: api-resource* The root-level record that is supposed to represent a single Terms of Service. # Terms of service The root-level record that is supposed to represent a single Terms of Service. --- ## Terms of service (Base) *Type: resource | Category: api-resource* The root-level record that is supposed to represent a single Terms of Service. # Terms of service (Base) The root-level record that is supposed to represent a single Terms of Service. --- ## Terms of service user status *Type: resource | Category: api-resource* The association between a Terms of Service and a user. # Terms of service user status The association between a Terms of Service and a user. --- ## Terms of service user statuses *Type: resource | Category: api-resource* A list of terms of service user statuses. # Terms of service user statuses A list of terms of service user statuses. --- ## Terms of services *Type: resource | Category: api-resource* A list of terms of services. # Terms of services A list of terms of services. --- ## The entity with type and ID *Type: resource | Category: api-resource* The entity with type and ID. # The entity with type and ID The entity with type and ID. --- ## Timeline Skill Card *Type: resource | Category: api-resource* A Box Skill metadata card that places a list of images on a timeline. # Timeline Skill Card A Box Skill metadata card that places a list of images on a timeline. --- ## Transcript Skill Card. *Type: resource | Category: api-resource* A Box Skill metadata card that adds a transcript to a file. # Transcript Skill Card. A Box Skill metadata card that adds a transcript to a file. --- ## Transfer owned folders *Type: endpoint | Category: api-endpoint* # undefined /reference/put-users-id-folders-0/ **Reference:** https://developer.box.com/reference/put-users-id-folders-0/ --- ## Trashed File *Type: resource | Category: api-resource* Represents a trashed file. # Trashed File Represents a trashed file. --- ## Trashed File (Restored) *Type: resource | Category: api-resource* Represents a file restored from the trash. # Trashed File (Restored) Represents a file restored from the trash. --- ## Trashed Folder *Type: resource | Category: api-resource* Represents a trashed folder. # Trashed Folder Represents a trashed folder. --- ## Trashed Folder (Restored) *Type: resource | Category: api-resource* Represents a folder restored from the trash. # Trashed Folder (Restored) Represents a folder restored from the trash. --- ## Trashed Web Link *Type: resource | Category: api-resource* Represents a trashed web link. # Trashed Web Link Represents a trashed web link. --- ## Trashed Web Link (Restored) *Type: resource | Category: api-resource* Represents a web link restored from the trash. # Trashed Web Link (Restored) Represents a web link restored from the trash. --- ## Unassign legal hold policy *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-legal-hold-policy-assignments-id/ **Reference:** https://developer.box.com/reference/delete-legal-hold-policy-assignments-id/ --- ## Unassign storage policy *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-storage-policy-assignments-id/ **Reference:** https://developer.box.com/reference/delete-storage-policy-assignments-id/ --- ## Unassign task *Type: endpoint | Category: api-endpoint* # undefined /reference/delete-task-assignments-id/ **Reference:** https://developer.box.com/reference/delete-task-assignments-id/ --- ## Update AI agent *Type: endpoint | Category: api-endpoint* # undefined /reference/put-ai-agents-id/ **Reference:** https://developer.box.com/reference/put-ai-agents-id/ --- ## Update all Box Skill cards on file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-skill-invocations-id/ **Reference:** https://developer.box.com/reference/put-skill-invocations-id/ --- ## Update Box Skill cards on file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id-metadata-global-boxSkillsCards/ **Reference:** https://developer.box.com/reference/put-files-id-metadata-global-boxSkillsCards/ --- ## Update classification *Type: endpoint | Category: api-endpoint* # undefined /reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update/ **Reference:** https://developer.box.com/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update/ --- ## Update classification on file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Update classification on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ **Reference:** https://developer.box.com/reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo/ --- ## Update collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/put-collaborations-id/ **Reference:** https://developer.box.com/reference/put-collaborations-id/ --- ## Update comment *Type: endpoint | Category: api-endpoint* # undefined /reference/put-comments-id/ **Reference:** https://developer.box.com/reference/put-comments-id/ --- ## Update file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id/ **Reference:** https://developer.box.com/reference/put-files-id/ --- ## Update file request *Type: endpoint | Category: api-endpoint* # undefined /reference/put-file-requests-id/ **Reference:** https://developer.box.com/reference/put-file-requests-id/ --- ## Update folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id/ **Reference:** https://developer.box.com/reference/put-folders-id/ --- ## Update group *Type: endpoint | Category: api-endpoint* # undefined /reference/put-groups-id/ **Reference:** https://developer.box.com/reference/put-groups-id/ --- ## Update group membership *Type: endpoint | Category: api-endpoint* # undefined /reference/put-group-memberships-id/ **Reference:** https://developer.box.com/reference/put-group-memberships-id/ --- ## Update hub collaboration *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/put-hub-collaborations-id/ **Reference:** https://developer.box.com/reference/v2025.0/put-hub-collaborations-id/ --- ## Update hub information by ID *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/put-hubs-id/ **Reference:** https://developer.box.com/reference/v2025.0/put-hubs-id/ --- ## Update legal hold policy *Type: endpoint | Category: api-endpoint* # undefined /reference/put-legal-hold-policies-id/ **Reference:** https://developer.box.com/reference/put-legal-hold-policies-id/ --- ## Update metadata instance on file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/put-files-id-metadata-id-id/ --- ## Update metadata instance on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id-metadata-id-id/ **Reference:** https://developer.box.com/reference/put-folders-id-metadata-id-id/ --- ## Update metadata template *Type: endpoint | Category: api-endpoint* # undefined /reference/put-metadata-templates-id-id-schema/ **Reference:** https://developer.box.com/reference/put-metadata-templates-id-id-schema/ --- ## Update retention policy *Type: endpoint | Category: api-endpoint* # undefined /reference/put-retention-policies-id/ **Reference:** https://developer.box.com/reference/put-retention-policies-id/ --- ## Update shared link on file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-id--update-shared-link/ **Reference:** https://developer.box.com/reference/put-files-id--update-shared-link/ --- ## Update shared link on folder *Type: endpoint | Category: api-endpoint* # undefined /reference/put-folders-id--update-shared-link/ **Reference:** https://developer.box.com/reference/put-folders-id--update-shared-link/ --- ## Update shared link on web link *Type: endpoint | Category: api-endpoint* # undefined /reference/put-web-links-id--update-shared-link/ **Reference:** https://developer.box.com/reference/put-web-links-id--update-shared-link/ --- ## Update shield information barrier segment with specified ID *Type: endpoint | Category: api-endpoint* # undefined /reference/put-shield-information-barrier-segments-id/ **Reference:** https://developer.box.com/reference/put-shield-information-barrier-segments-id/ --- ## Update shield list *Type: endpoint | Category: api-endpoint* # undefined /reference/v2025.0/put-shield-lists-id/ **Reference:** https://developer.box.com/reference/v2025.0/put-shield-lists-id/ --- ## Update Slack integration mapping *Type: endpoint | Category: api-endpoint* # undefined /reference/put-integration-mappings-slack-id/ **Reference:** https://developer.box.com/reference/put-integration-mappings-slack-id/ --- ## Update storage policy assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/put-storage-policy-assignments-id/ **Reference:** https://developer.box.com/reference/put-storage-policy-assignments-id/ --- ## Update task *Type: endpoint | Category: api-endpoint* # undefined /reference/put-tasks-id/ **Reference:** https://developer.box.com/reference/put-tasks-id/ --- ## Update task assignment *Type: endpoint | Category: api-endpoint* # undefined /reference/put-task-assignments-id/ **Reference:** https://developer.box.com/reference/put-task-assignments-id/ --- ## Update Teams integration mapping *Type: endpoint | Category: api-endpoint* # undefined /reference/put-integration-mappings-teams-id/ **Reference:** https://developer.box.com/reference/put-integration-mappings-teams-id/ --- ## Update terms of service *Type: endpoint | Category: api-endpoint* # undefined /reference/put-terms-of-services-id/ **Reference:** https://developer.box.com/reference/put-terms-of-services-id/ --- ## Update terms of service status for existing user *Type: endpoint | Category: api-endpoint* # undefined /reference/put-terms-of-service-user-statuses-id/ **Reference:** https://developer.box.com/reference/put-terms-of-service-user-statuses-id/ --- ## Update user *Type: endpoint | Category: api-endpoint* # undefined /reference/put-users-id/ **Reference:** https://developer.box.com/reference/put-users-id/ --- ## Update web link *Type: endpoint | Category: api-endpoint* # undefined /reference/put-web-links-id/ **Reference:** https://developer.box.com/reference/put-web-links-id/ --- ## Update webhook *Type: endpoint | Category: api-endpoint* # undefined /reference/put-webhooks-id/ **Reference:** https://developer.box.com/reference/put-webhooks-id/ --- ## Upload file *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-content/ **Reference:** https://developer.box.com/reference/post-files-content/ --- ## Upload file version *Type: endpoint | Category: api-endpoint* # undefined /reference/post-files-id-content/ **Reference:** https://developer.box.com/reference/post-files-id-content/ --- ## Upload part *Type: resource | Category: api-resource* The representation of an upload session chunk. # Upload part The representation of an upload session chunk. --- ## Upload part (Mini) *Type: resource | Category: api-resource* The basic representation of an upload session chunk. # Upload part (Mini) The basic representation of an upload session chunk. --- ## Upload part of file *Type: endpoint | Category: api-endpoint* # undefined /reference/put-files-upload-sessions-id/ **Reference:** https://developer.box.com/reference/put-files-upload-sessions-id/ --- ## Upload parts *Type: resource | Category: api-resource* A list of uploaded chunks for an upload session. # Upload parts A list of uploaded chunks for an upload session. --- ## Upload session *Type: resource | Category: api-resource* An upload session for chunk uploading a file. # Upload session An upload session for chunk uploading a file. --- ## Upload URL *Type: resource | Category: api-resource* The details for the upload session for the file. # Upload URL The details for the upload session for the file. --- ## Uploaded part *Type: resource | Category: api-resource* A chunk of a file uploaded as part of an upload session, as returned by some endpoints. # Uploaded part A chunk of a file uploaded as part of an upload session, as returned by some endpoints. --- ## User *Type: resource | Category: api-resource* A standard representation of a user, as returned from any user API endpoints by default. # User A standard representation of a user, as returned from any user API endpoints by default. --- ## User (Base) *Type: resource | Category: api-resource* A mini representation of a user, used when nested within another resource. # User (Base) A mini representation of a user, used when nested within another resource. --- ## User (Collaborations) *Type: resource | Category: api-resource* A mini representation of a user, can be returned only when the status is `pending`. # User (Collaborations) A mini representation of a user, can be returned only when the status is `pending`. --- ## User (Full) *Type: resource | Category: api-resource* A full representation of a user, as can be returned from any user API endpoint. # User (Full) A full representation of a user, as can be returned from any user API endpoint. --- ## User (Integration Mappings) *Type: resource | Category: api-resource* A user representation for integration mappings API purposes. Fields name and login are not required. # User (Integration Mappings) A user representation for integration mappings API purposes. Fields name and login are not required. --- ## User (Mini) *Type: resource | Category: api-resource* A mini representation of a user, as can be returned when nested within other resources. # User (Mini) A mini representation of a user, as can be returned when nested within other resources. --- ## User avatar *Type: resource | Category: api-resource* A resource holding URLs to the avatar uploaded to a Box application. # User avatar A resource holding URLs to the avatar uploaded to a Box application. --- ## Users *Type: resource | Category: api-resource* A list of users. # Users A list of users. --- ## Watermark *Type: resource | Category: api-resource* A watermark is a semi-transparent overlay on an embedded file preview that displays a viewer's email address or user ID and the time of access over a file's content. # Watermark A watermark is a semi-transparent overlay on an embedded file preview that displays a viewer's email address or user ID and the time of access over a file's content. --- ## Web link *Type: resource | Category: api-resource* Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. # Web link Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. --- ## Web link (Base) *Type: resource | Category: api-resource* Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. # Web link (Base) Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. --- ## Web link (Mini) *Type: resource | Category: api-resource* Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. # Web link (Mini) Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to file objects, they will also support most actions that apply to regular files. --- ## Webhook *Type: resource | Category: api-resource* Represents a configured webhook. # Webhook Represents a configured webhook. --- ## Webhook (Mini) *Type: resource | Category: api-resource* Represents a configured webhook. # Webhook (Mini) Represents a configured webhook. --- ## Webhook (V2) payload *Type: resource | Category: api-resource* The event that is sent to a webhook address when an event happens. # Webhook (V2) payload The event that is sent to a webhook address when an event happens. --- ## Webhooks *Type: resource | Category: api-resource* A list of webhooks. # Webhooks A list of webhooks. --- ## Workflow *Type: resource | Category: api-resource* Box Relay Workflows are objects that represent a named collection of flows. Your application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. # Workflow Box Relay Workflows are objects that represent a named collection of flows. Your application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. --- ## Workflow (Full) *Type: resource | Category: api-resource* Box Relay Workflows are objects that represent a named collection of flows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. # Workflow (Full) Box Relay Workflows are objects that represent a named collection of flows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. --- ## Workflow (Mini) *Type: resource | Category: api-resource* Box Relay Workflows are objects that represent a named collection of flows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. # Workflow (Mini) Box Relay Workflows are objects that represent a named collection of flows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. --- ## Workflows *Type: resource | Category: api-resource* A list of workflows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. # Workflows A list of workflows. You application must be authorized to use the `Manage Box Relay` application scope within the developer console in order to use this resource. --- ## Zip download *Type: resource | Category: api-resource* Represents a successful request to create a `zip` archive of a list of files and folders. # Zip download Represents a successful request to create a `zip` archive of a list of files and folders. --- ## Zip download status *Type: resource | Category: api-resource* The status of a `zip` archive being downloaded. # Zip download status The status of a `zip` archive being downloaded. --- ---