{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Box Dev Docs","description":"Box for Developers: guides, API reference, SDKs, and tutorials for building content management, Box AI, and enterprise integrations.","colors":{"primary":"#0061d5","light":"#f6fafd","dark":"#002947"},"logo":{"light":"https://mintcdn.com/box/lJLw9z7FWORNWMcq/logo/boxdev-light.png?fit=max\u0026auto=format\u0026n=lJLw9z7FWORNWMcq\u0026q=85\u0026s=a11710b698ff59d24426f9ecec6c7e9c","dark":"https://mintcdn.com/box/siVVIgx7pBuvW4ua/logo/boxdev-dark.svg?fit=max\u0026auto=format\u0026n=siVVIgx7pBuvW4ua\u0026q=85\u0026s=0e34af393abb1b8c024258d684bb7732"},"favicon":"https://mintcdn.com/box/T2hwpVFBJMA4eeDs/favicon.ico?fit=max\u0026auto=format\u0026n=T2hwpVFBJMA4eeDs\u0026q=85\u0026s=2a2efcc60e46eca7ee3ebbe650c47350","api":{"examples":{"languages":["curl","python","node","swift","java",".Net"],"autogenerate":false}},"seo":{"metatags":{"google-site-verification":"fuelbNhVR1kQluNBJjYt4K1Hj5HvJLhLnIq0o9CAY9E"}},"fonts":{"family":"Inter"},"contextual":{"options":[{"title":"Install Box Agent Skills","description":"Add Box plugins to your AI assistants","icon":"sparkles","href":"/ai/agent-skills"},"cursor","vscode","mcp","chatgpt","claude","perplexity","copy","view"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","banner":{"content":"Join BoxWorks Dev Summit on Nov 5-6, San Francisco and dive into AI agents and unstructured content. [See agenda](https://boxworks.box.com/series/boxworks-2026-dev-summit/landing_page).","dismissible":true},"footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"Resources","items":[{"label":"Newsletter unsubscribe","href":"https://go.box.com/preferences.html"},{"label":"Terms of Use","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"Privacy Policy","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookie Notification","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"Log in","type":"button"}],"primary":{"type":"button","label":"Get started for free","href":"https://account.box.com/signup/developer"}},"href":""},{"language":"ja","footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"リソース","items":[{"label":"ニュースレターの登録解除","href":"https://go.box.com/preferences.html"},{"label":"利用規約","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"個人情報保護方針","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookieに関する通知","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"ログイン","type":"button"}],"primary":{"type":"button","label":"今すぐ無料で開始","href":"https://account.box.com/signup/developer#ty9l3"}},"href":"ja"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"box","hasAudioNarration":false,"actualSubdomain":"box","customDomains":["developer.box.com"],"gitSource":{"type":"github","owner":"box","repo":"box-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ace4f18da1222a327254823","collectionId":"afc5674c-f132-4ba9-9769-de8c5c2eab55","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ace4f18da1222a327254823"},"feedback":{"thumbs":true,"issues":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6acf592abe1663ec60b0a5cb","clientVersion":"0.0.3835","searchFilterCounts":[{"language":"en","tag":"API reference","count":638},{"language":"en","tag":"Home","count":368},{"language":"ja","tag":"ホーム","count":368},{"language":"ja","tag":"APIリファレンス","count":341},{"language":"en","tag":"AI","count":191},{"language":"ja","tag":"AI","count":161},{"language":"ja","tag":"コラボレーション","count":80},{"language":"en","tag":"Tools","count":77},{"language":"en","tag":"Dev tools","count":77},{"language":"ja","tag":"ツール","count":75},{"language":"ja","tag":"開発ツール","count":75},{"language":"en","tag":"Metadata \u0026 search","count":67},{"language":"ja","tag":"メタデータと検索","count":67},{"language":"en","tag":"Collaboration","count":62},{"language":"en","tag":"Content","count":58},{"language":"ja","tag":"コンテンツ","count":58},{"language":"en","tag":"Metadata","count":49},{"language":"ja","tag":"メタデータ","count":49},{"language":"en","tag":"Supported AI models","count":46},{"language":"ja","tag":"IDとアクセス","count":40}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":true},"hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false},"customCss":[{"filePath":"styles.css","content":"a code{border-bottom-color:none!important}.prose :where(a code):not(:where([class~=\"not-prose\"], [class~=\"not-prose\"] *)){color:inherit;font-weight:inherit;text-decoration:none;text-decoration-color:rgb(var(--primary));text-underline-offset:0;text-decoration-thickness:1px}#consent_blackbar{position:relative;z-index:9999999!important}#sidebar,.left-0.right-0.sticky.sm\\:px-4.pb-4.sm\\:pb-6.bottom-0.pt-1.flex.flex-col.items-center.w-full.overflow-hidden.z-20{z-index:1}#footer>div,#sidebar-content{z-index:0}a.nav-anchor img[src$=\"/images/sidebar/box.svg\"]{background-color:transparent!important}#truste-consent-track{z-index:9999999!important;position:fixed!important}.dark #truste-consent-track{background-color:#151f26!important;border-color:#1a1a1a}.dark #truste-show-consent{background-color:#fff;color:#151f26}.dark #truste-consent-text{color:#fff}#truste-consent-content{max-width:1400px}.homepage_container .card img{max-height:200px}.homepage_container h1 span,.homepage_container h2 span{margin:auto}#navbar .max-w-8xl.mx-auto.relative button .ml-4.flex.text-sm.leading-6.whitespace-nowrap.min-w-0.space-x-3.overflow-hidden,header#header .eyebrow{display:none!important}.sidebar-group-header:has(+.sidebar-group>li:is(\n [id=\"/reference\"],\n [id=\"/ja/reference\"],\n [id=\"/ja/reference/v2025.0\"],\n [id=\"/ja/reference/v2026.0\"]\n))>.sidebar-title{display:none}footer div.flex.gap-4.flex-col.md\\:flex-row.md\\:items-center.md\\:gap-8.md\\:justify-center{flex-wrap:wrap}footer div.flex.gap-4.flex-col.md\\:flex-row.md\\:items-center.md\\:gap-8.md\\:justify-center a{white-space:nowrap;text-overflow:clip;overflow:visible;align-self:start;flex-shrink:0;cursor:pointer!important}#google-preferred-source-column{display:flex;flex-direction:column;align-items:flex-end;flex:0 0 auto;width:max-content;max-width:100%}#google-preferred-source{display:flex;justify-content:flex-end;width:auto;margin:0;padding-top:16px}.google-preferred-source-button{appearance:none;margin:0;padding:0;border:0;background:0 0;line-height:0;cursor:pointer}.google-preferred-source-badge{display:block;width:140px;max-width:100%;height:auto}.dark .google-preferred-source-badge--light,.google-preferred-source-badge--dark{display:none}.dark .google-preferred-source-badge--dark{display:block}.nav-logo{min-width:109px}.badge-guide,.badge-quickstart,.badge-tutorial,.dark .badge-guide,.dark .badge-quickstart,.dark .badge-tutorial{background-color:#1f2937;color:#fff}.badge-get{background-color:rgb(74 222 128/.2);color:#15803d}.dark .badge-get{color:#4ade80}.badge-post{background-color:rgb(96 165 250/.2);color:#1d4ed8}.dark .badge-post{color:#60a5fa}.badge-patch,.badge-put{background-color:rgb(250 204 21/.2);color:#a16207}.dark .badge-patch,.dark .badge-put{color:#facc15}.badge-delete{background-color:rgb(248 113 113/.2);color:#b91c1c}.dark .badge-delete{color:#f87171}.badge-api{background-color:#e3f2fd;color:#0d47a1}.dark .badge-api{background-color:#0d47a1;color:#bbdefb}.badge-documentation,.badge-reference,.dark .badge-documentation,.dark .badge-reference{background-color:#000;color:#fff}.badge-default{background-color:#f5f5f5;color:#424242}.badge-group{display:inline-flex;gap:.5rem;flex-wrap:wrap}.dark .badge-default{background-color:#424242;color:#e0e0e0}.update>div:first-child>div:nth-child(3){padding:0;order:4}.update>div:first-child>div:nth-child(3)>span{display:flex;padding:.25rem .75rem;align-items:center;border-radius:9999px;font-size:.875rem;line-height:1.25rem;color:#374151;background-color:#f3f4f6}.dark .update>div:first-child>div:nth-child(3)>span{color:#cecece;background-color:#161616}.update>div:first-child>div:nth-child(4){order:3}div#banner a{text-decoration:none!important;color:#fff;font-weight:600}nav ul #topbar-cta-button a span,nav ul .navbar-link a{border-radius:50px!important}nav ul #topbar-cta-button a span{background-color:#0061d5}#topbar-cta-button a:hover span{opacity:1!important;background-color:#146bd5}.dark #topbar-cta-button a:hover span{opacity:1!important;background-color:#0058c3}.signup-cta-button,.signup-cta-button:active,.signup-cta-button:focus,.signup-cta-button:hover{background-color:#0061d5;border-radius:50px!important;transition:background-color .2s!important;box-shadow:none!important;transform:none!important;border:0!important;border-bottom:none!important;text-decoration:none!important;outline:0!important}.signup-cta-button:hover{background-color:#146bd5!important;opacity:1!important}.dark .signup-cta-button:hover{background-color:#0058c3!important;opacity:1!important}.homepage-secondary-button,.homepage-secondary-button:active,.homepage-secondary-button:focus,.homepage-secondary-button:hover{border-radius:50px!important;border:1px solid #d1d5db!important;background-color:transparent!important;color:#1f2937!important;transition:background-color .2s!important;box-shadow:none!important;transform:none!important;text-decoration:none!important;outline:0!important}.homepage-secondary-button:hover{background-color:#f9fafb!important}.dark .homepage-secondary-button,.dark .homepage-secondary-button:active,.dark .homepage-secondary-button:focus{border-color:#4b5563!important;color:#e5e7eb!important}.dark .homepage-secondary-button:hover{background-color:#1f2937!important}.signup-cta-login,.signup-cta-login:active,.signup-cta-login:focus,.signup-cta-login:hover{text-decoration:none!important;border-bottom:none!important}#content-area h1,#content-area h2,#content-area h3,#content-area h4,#content-area h5,#content-area h6{font-weight:600!important}#content-area h1{font-size:32px!important}.dark img[src*=\"guides-box-ai-ai-models/claude.svg\"],.dark img[src*=\"guides-box-ai-ai-models/gemini.svg\"],.dark img[src*=\"guides-box-ai-ai-models/grok.svg\"],.dark img[src*=\"guides-box-ai-ai-models/meta.svg\"],.dark img[src*=\"guides-box-ai-ai-models/mistral.svg\"],.dark img[src*=\"guides-box-ai-ai-models/openai.svg\"]{filter:invert(1)}.homepage_h2{font-size:28px!important}.chat-assistant-floating-input{z-index:1!important}"}],"page":{"pagePath":"ja/sample-code","slug":"/ja/sample-code","pageMetadata":{"description":"Box API、SDK、およびUI Elementsのサンプルコードとデモアプリケーションを確認する","mode":"wide","title":"サンプルコードカタログ","href":"/ja/sample-code"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Box API、SDK、およびUI Elementsのサンプルコードとデモアプリケーションを確認する\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const SampleCodeCatalog=()=>{const _components={a:`a`,..._provideComponents()};const[selectedLanguage,setSelectedLanguage]=useState(`All languages`);const[selectedTag,setSelectedTag]=useState(`All tags`);const[languageDropdownOpen,setLanguageDropdownOpen]=useState(false);const[tagDropdownOpen,setTagDropdownOpen]=useState(false);const sampleData=[{title:translate(`Box AI Python Workshop`),href:`https://github.com/barduinor/box-python-gen-workshop/blob/main/workshops/intelligence/intelligence.md`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`Box Custom Portal Demo`),href:`https://github.com/box-community/box-custom-portal-demo`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:translate([`UI ELEMENTS`,`FRONTEND`])},{title:translate(`Box Web App Integration Demo with Vercel`),href:`https://github.com/box-community/box-web-app-integration-demo`,icon:`/static/samples/javascript.svg`,languages:[`JavaScript`],tags:translate([`FRONTEND`,`API`])},{title:translate(`Metadata view in Content Explorer`),href:`https://github.com/box-community/content-explorer-metadata`,icon:`/static/samples/nodejs.svg`,languages:[`Node`,`React`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`Video Bookmarking Demo`),href:`https://github.com/pchristensenB/box-videobookmarking-demo`,icon:`/static/samples/nodejs.svg`,languages:[`Node`,`JavaScript`],tags:[translate(`API`)]},{title:translate(`Typescript SDK`),href:`https://github.com/box-community/box-ts-sdk-react`,icon:`/static/samples/typescript.svg`,languages:[`TypeScript`],tags:[translate(`SDK`)]},{title:translate(`.NET SDK Generated`),href:`https://github.com/box/box-dotnet-sdk-gen?tab=readme-ov-file#box-dotnet-sdk-generated`,icon:`/static/samples/dotnet.svg`,languages:[`.NET`],tags:[translate(`SDK`)]},{title:translate(`Box TypeScript SDK GENERATED (beta)`),href:`https://github.com/box/box-typescript-sdk-gen#box-typescript-sdk-generated`,icon:`/static/samples/typescript.svg`,languages:[`TypeScript`],tags:[translate(`SDK`)]},{title:translate(`Get started: Box Node.js SDK \u0026 OAuth 2.0`),href:`https://github.com/box-community/Box-node.js-SKD-with-OAuth-2.0`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SDK`)]},{title:translate(`Vercel Serverless Demo`),href:`https://github.com/box-community/box-vercel-serverless-demo`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`),translate(`WEBHOOKS`)]},{title:translate(`Mini Box Mediainfo Video Metadata Uploader`),href:`https://github.com/box-community/mini-box-mediaInfo-video-metadata-uploader`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`Diver Portal Demo`),href:`https://github.com/box-community/ui-elements-sample-app`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`Angular Box UI Elements Quickstart`),href:`https://github.com/SowaProgramuje/angular-box-ui-elements-cdn`,icon:`/static/samples/angular.svg`,languages:[`Angular`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`UI Elements Demo`),href:`https://github.com/box-community/ui-elements-demo`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`UI Elements Demo with JWT`),href:`https://github.com/box-community/ui-elements-jwt`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`UI Elements Demo using Python`),href:`https://github.com/box-community/ui-elements-python`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`,`Python`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`UI Elements Demo with OAuth 2.0`),href:`https://github.com/box-community/ui-elements-oauth`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`,`Python`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`Sharing Folders using the Box CLI`),href:`https://github.com/box-community/box-cli-100k/tree/main`,icon:`/static/samples/powershell.svg`,languages:[`PowerShell`],tags:[translate(`CLI`),translate(`API`)]},{title:translate(`Box Metadata Media Uploader`),href:`https://github.com/box-community/box-metadata-media/tree/main`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`Vue.js Box UI Elements Quickstart`),href:`https://github.com/SowaProgramuje/vue3-box-ui-elements-cdn`,icon:`/static/samples/vue.js.svg`,languages:[`Vue.js`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`Java SDK`),href:`https://github.com/box/box-java-sdk/tree/main/src/example`,icon:`/static/samples/java.svg`,languages:[`Java`],tags:[translate(`SDK`)]},{title:translate(`Box CLI`),href:`https://github.com/box/boxcli/tree/main/examples`,icon:`/static/samples/powershell.svg`,languages:[`PowerShell`],tags:[translate(`CLI`),translate(`PROVISIONING`)]},{title:translate(`Box UI Elements`),href:`https://github.com/box/box-ui-elements/tree/master/examples`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`.NET SDK`),href:`https://github.com/box/box-windows-sdk-v2/tree/main/docs`,icon:`/static/samples/dotnet.svg`,languages:[`.NET`],tags:[translate(`SDK`)]},{title:translate(`Box Annotations`),href:`https://github.com/box/box-annotations/tree/master/docs`,icon:`/static/samples/javascript.svg`,languages:[`JavaScript`],tags:[translate(`FRONTEND`)]},{title:translate(`iOS SDK`),href:`https://github.com/box/box-ios-sdk/tree/main/docs/usage`,icon:`/static/samples/swift.svg`,languages:[`Swift`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`Node SDK`),href:`https://github.com/box/box-node-sdk/tree/main/docs`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SDK`)]},{title:translate(`Box Python SDK GENERATED (beta)`),href:`https://github.com/box/box-python-sdk-gen`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`SDK`)]},{title:translate(`Box Python SDK`),href:`https://github.com/box/box-python-sdk/tree/main/docs/usage`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`SDK`)]},{title:translate(`Android Browse SDK`),href:`https://github.com/box/box-android-browse-sdk`,icon:`/static/samples/android.svg`,languages:[`Android`,`Java`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`Android Share SDK`),href:`https://github.com/box/box-android-share-sdk`,icon:`/static/samples/java.svg`,languages:[`Java`,`Android`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`Content Preview`),href:`https://github.com/box/box-content-preview`,icon:`/static/samples/javascript.svg`,languages:[`JavaScript`],tags:[translate(`FRONTEND`)]},{title:translate(`UI Elements Demo`),href:`https://github.com/box/box-ui-elements-demo`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:[translate(`UI ELEMENTS`),translate(`FRONTEND`)]},{title:translate(`Skills Kit Nodejs`),href:`https://github.com/box/box-skills-kit-nodejs`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Salesforce SDK`),href:`https://github.com/box/box-salesforce-sdk/tree/master/doc`,icon:`/static/samples/apex.svg`,languages:[`APEX`],tags:[translate(`SALESFORCE`),translate(`SDK`)]},{title:translate(`Android SDK (deprecated)`),href:`https://github.com/box/box-android-sdk/tree/master/doc`,icon:`/static/samples/android.svg`,languages:[`Android`,`Java`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`iOS Preview SDK`),href:`https://github.com/box/box-ios-preview-sdk`,icon:`/static/samples/swift.svg`,languages:[`Swift`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`OpenAI Skill Demo`),href:`https://github.com/box-community/box-open-ai-skill-demo`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`cURL Samples`),href:`https://github.com/box-community/box-curl-samples`,icon:`/static/samples/curl.svg`,languages:[`cURL`],tags:[translate(`API`)]},{title:translate(`Box Skills Starter Kit`),href:`https://github.com/box-community/Box-Custom-Skills-Starter`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Authenticate with JWT Demo`),href:`https://github.com/box-community/samples-docs-authenticate-with-jwt-api/blob/master/sample.js`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`)]},{title:translate(`JavaScript SDK`),href:`https://github.com/box-community/box-javascript-sdk`,icon:`/static/samples/javascript.svg`,languages:[`JavaScript`],tags:[translate(`SDK`),translate(`FRONTEND`)]},{title:translate(`Box for Salesforce Demo`),href:`https://github.com/box-community/box-salesforce-demo`,icon:`/static/samples/apex.svg`,languages:[`APEX`],tags:[translate(`SALESFORCE`)]},{title:translate(`JSON Ref Resolver`),href:`https://github.com/box-community/json-ref-resolver`,icon:`/static/samples/javascript.svg`,languages:[`JavaScript`],tags:[translate(`API`),translate(`FRONTEND`)]},{title:translate(`Python Administration Kit`),href:`https://github.com/box-community/tool-python-admin-kit`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`Sample JWT App Primer`),href:`https://github.com/box-community/sample-jwt-app-primer`,icon:`/static/samples/universal.svg`,languages:[`Universal`],tags:[translate(`API`)]},{title:translate(`Splunk Dashboards`),href:`https://github.com/box-community/splunk-dashboards`,icon:`/static/samples/universal.svg`,languages:[`Universal`],tags:[translate(`API`)]},{title:translate(`PowerShell SDK`),href:`https://github.com/box-community/sdk-powershell-api-v2`,icon:`/static/samples/powershell.svg`,languages:[`PowerShell`],tags:[translate(`SDK`)]},{title:translate(`Python Batch Folder Tree Rename`),href:`https://github.com/box-community/tool-python-batch-folder-tree-rename`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`Python Move Folder to Account`),href:`https://github.com/box-community/tool-python-move-folder-to-account`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`PHP Simple User Reports`),href:`https://github.com/box-community/tool-php-simple-user-reports`,icon:`/static/samples/php.svg`,languages:[`PHP`],tags:[translate(`API`)]},{title:translate(`Perl Folder IDs to Paths`),href:`https://github.com/box-community/tool-perl-folderids-to-paths`,icon:`/static/samples/perl.svg`,languages:[`Perl`],tags:[translate(`API`)]},{title:translate(`iOS Browse SDK`),href:`https://github.com/box/box-ios-browse-sdk`,icon:`/static/samples/swift.svg`,languages:[`Swift`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`iOS Share SDK`),href:`https://github.com/box/box-ios-share-sdk`,icon:`/static/samples/swift.svg`,languages:[`Swift`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`Android Preview SDK`),href:`https://github.com/box/box-android-preview-sdk`,icon:`/static/samples/android.svg`,languages:[`Android`,`Java`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`Android Simple Tooltip`),href:`https://github.com/box/android-simple-tooltip`,icon:`/static/samples/android.svg`,languages:[`Android`,`Java`],tags:[translate(`MOBILE`)]},{title:translate(`Box Content Preview Demo`),href:`https://github.com/box/box-content-preview-demo`,icon:`/static/samples/react.svg`,languages:[`React`,`JavaScript`],tags:[translate(`FRONTEND`)]},{title:translate(`Java SDK Samples`),href:`https://github.com/box/box-java-sdk-samples`,icon:`/static/samples/java.svg`,languages:[`Java`],tags:[translate(`API`)]},{title:translate(`.NET Metadata SDK V2`),href:`https://github.com/box/box-windows-metadata-sdk-v2`,icon:`/static/samples/dotnet.svg`,languages:[`.NET`],tags:[translate(`SDK`),translate(`API`)]},{title:translate(`Android App to App SDK`),href:`https://github.com/box/box-android-apptoapp-sdk`,icon:`/static/samples/android.svg`,languages:[`Android`,`Java`],tags:[translate(`SDK`),translate(`MOBILE`)]},{title:translate(`Ruby SDK`),href:`https://github.com/cburnette/boxr`,icon:`/static/samples/ruby.svg`,languages:[`Ruby`],tags:[translate(`SDK`)]},{title:translate(`R SDK`),href:`https://github.com/r-box/boxr`,icon:`/static/samples/r.svg`,languages:[`R`],tags:[translate(`SDK`)]},{title:translate(`Box Jira Etsi Document Control`),href:`https://github.com/goodgrid/etsi-document-control`,icon:`/static/samples/javascript.svg`,languages:[`JavaScript`],tags:[translate(`API`),translate(`FRONTEND`)]},{title:translate(`Box PowerShell Automations`),href:`https://github.com/kylefernandadams/box-powershell-automations`,icon:`/static/samples/powershell.svg`,languages:[`PowerShell`],tags:[translate(`API`),translate(`PROVISIONING`)]},{title:translate(`Microsoft Azure Media Services Box Skill`),href:`https://github.com/box-community/sample-video-skills/tree/master/microsoft-azure-faces-transcript-topics-detection`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Postman Collection`),href:`https://developer.box.com/guides/tooling/postman/`,icon:`/static/samples/universal.svg`,languages:[`Universal`],tags:[translate(`API`)]},{title:translate(`AWS Lambda Function to Save Logs`),href:`https://github.com/kenji-toforone/box-auditlogs-node-es`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`)]},{title:translate(`Python Async Rate Limiter`),href:`https://github.com/jmfrank63/box-python-async-rate-limiter`,icon:`/static/samples/python.svg`,languages:[`Python`],tags:[translate(`API`)]},{title:translate(`Box for Salesforce Blueprints`),href:`https://github.com/kylefernandadams/box-for-salesforce-blueprints`,icon:`/static/samples/apex.svg`,languages:[`APEX`],tags:[translate(`SALESFORCE`)]},{title:translate(`Leverton Lease Extraction`),href:`https://github.com/box-community/sample-document-skills/tree/master/leverton-lease-extraction`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Rossum Invoice Intelligence`),href:`https://github.com/box-community/sample-document-skills/tree/master/rossum-invoice-intelligence`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`IBM Watson Audio Transcript Extraction`),href:`https://github.com/box-community/sample-audio-skills/tree/master/ibm-watson-transcript-extraction`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Microsoft Azure Audio Transcript Extraction`),href:`https://github.com/box-community/sample-audio-skills/tree/master/microsoft-azure-transcript-topics-detection`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`VoiceBase Dual Channel Audio Analysis`),href:`https://github.com/box-community/sample-audio-skills/tree/master/voicebase-callcenter-audio-analysis`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Acuant AssureID Box Skill`),href:`https://github.com/box-community/sample-image-skills/tree/master/acuant-assureid-goverment-id-data-extraction`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Amazon Rekognition Label Extraction`),href:`https://github.com/box-community/sample-image-skills/tree/master/amazon-rekognition-labels-detection`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`EXIF/XMP MetaInfo Extraction`),href:`https://github.com/box-community/sample-image-skills/tree/master/exiftool-metainfo-extraction`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Google Cloud Vision Product Search`),href:`https://github.com/box-community/sample-image-skills/tree/master/google-product-search-integration`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Google Vision Image Extraction`),href:`https://github.com/box-community/sample-image-skills/tree/master/google-vision-text-topics-detection`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Hive Predict Face Recognition`),href:`https://github.com/box-community/sample-image-skills/tree/master/hive-predict-face-recognition`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Microsoft Vision Image Extraction`),href:`https://github.com/box-community/sample-image-skills/tree/master/microsoft-vision-text-topics-detection`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`ASP.NET MVC Skeleton App`),href:`https://github.com/box/samples/tree/master/box-aspnet-mvc-sk`,icon:`/static/samples/dotnet.svg`,languages:[`.NET`],tags:[translate(`API`)]},{title:translate(`Auth0 Angular 1 Skeleton App`),href:`https://github.com/box/samples/tree/master/box-auth0-angular1-skeleton-app-sample`,icon:`/static/samples/angularjs.svg`,languages:[`AngularJS`,`JavaScript`],tags:[translate(`API`),translate(`FRONTEND`)]},{title:translate(`Auth0 Angular 2 Skeleton App`),href:`https://github.com/box/samples/tree/master/box-auth0-angular2-skeleton-app-sample`,icon:`/static/samples/angular.svg`,languages:[`Angular`,`JavaScript`],tags:[translate(`API`),translate(`FRONTEND`)]},{title:translate(`Auth0 Swift Skeleton App`),href:`https://github.com/box/samples/tree/master/box-auth0-swift-skeleton-app-sample`,icon:`/static/samples/swift.svg`,languages:[`Swift`],tags:[translate(`API`),translate(`MOBILE`)]},{title:translate(`AWS Cognito Angular 2 Skeleton App`),href:`https://github.com/box/samples/tree/master/box-aws-cognito-angular2-skeleton-app-sample`,icon:`/static/samples/angular.svg`,languages:[`Angular`,`JavaScript`],tags:[translate(`API`),translate(`FRONTEND`)]},{title:translate(`Java Servlet Skeleton App`),href:`https://github.com/box/samples/tree/master/box-java-servlet-skeleton-app`,icon:`/static/samples/java.svg`,languages:[`Java`],tags:[translate(`API`)]},{title:translate(`Node Cognito Lambdas Sample`),href:`https://github.com/box/samples/tree/master/box-node-cognito-lambdas-sample`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`)]},{title:translate(`Node Custom Skills Sample`),href:`https://github.com/box/samples/tree/master/box-node-custom-skills-sample`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`SKILLS`)]},{title:translate(`Node Express Skeleton App`),href:`https://github.com/box/samples/tree/master/box-node-express-skeleton-app`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`)]},{title:translate(`Node Lambda Sample`),href:`https://github.com/box/samples/tree/master/box-node-lambda-sample`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`)]},{title:translate(`Node Rekognition Lambda Sample`),href:`https://github.com/box/samples/tree/master/box-node-rekognition-lambdas-sample`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`)]},{title:translate(`Node Webhook to Lambda Sample`),href:`https://github.com/box/samples/tree/master/box-node-webhook-to-lambda-sample`,icon:`/static/samples/nodejs.svg`,languages:[`Node`],tags:[translate(`API`),translate(`WEBHOOKS`)]}];const allLanguages=useMemo(()=>{const languageSet=new Set;sampleData.forEach(sample=>{sample.languages.forEach(lang=>languageSet.add(lang))});return[`All languages`,...Array.from(languageSet).sort()]},[]);const allTags=useMemo(()=>{const tagSet=new Set;sampleData.forEach(sample=>{sample.tags.forEach(tag=>tagSet.add(tag))});return[`All tags`,...Array.from(tagSet).sort()]},[]);const filteredSamples=useMemo(()=>{return sampleData.filter(sample=>{const languageMatch=selectedLanguage===`All languages`||sample.languages.includes(selectedLanguage);const tagMatch=selectedTag===`All tags`||sample.tags.includes(selectedTag);return languageMatch\u0026\u0026tagMatch})},[selectedLanguage,selectedTag]);const resetFilters=()=>{setSelectedLanguage(translate(`All languages`));setSelectedTag(translate(`All tags`))};const hasActiveFilters=selectedLanguage!==translate(`All languages`)||selectedTag!==translate(`All tags`);return _jsxs(`div`,{className:`mint-w-full mint-max-w-[1400px] mint-mx-auto`,children:[_jsxs(`div`,{className:`mint-relative mint-z-20 mint-flex mint-flex-wrap mint-gap-3 mint-mb-8 mint-items-center`,children:[_jsxs(`div`,{className:`mint-relative`,children:[_jsxs(`button`,{onClick:()=>{setLanguageDropdownOpen(!languageDropdownOpen);setTagDropdownOpen(false)},className:`mint-flex mint-items-center mint-justify-between mint-gap-3 mint-px-4 mint-py-2.5 mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-300 dark:mint-border-gray-600 mint-rounded-lg hover:mint-border-gray-400 dark:hover:mint-border-gray-500 mint-transition-colors mint-min-w-[180px]`,children:[_jsx(`span`,{className:`mint-text-sm mint-text-gray-700 dark:mint-text-gray-200`,children:selectedLanguage}),_jsx(`svg`,{xmlns:`http://www.w3.org/2000/svg`,width:`12`,height:`8`,fill:`none`,className:`mint-transition-transform ${languageDropdownOpen?`mint-rotate-180`:``}`,children:_jsx(`path`,{fill:`currentColor`,fillRule:`evenodd`,d:`m6.644 5.76808 4.34-3.766.75-.651996c.08352-.067492.15088-.152810.19716-.249704.04628-.096896.07030-.202916.07030-.310296 0-.107379-.02402-.213399-.07030-.310295C11.88488.382894 11.81752.297576 11.734.230084c-.18088-.151486-.41008-.233093-.646-.22999963H.912C.408.00008474 0 .354084 0 .790084c0 .21.096.412.266.56l.77.667996 4.32 3.75c.18130.14956.40898.23136.644.23136s.46270-.0818.644-.23136Z`,clipRule:`evenodd`})})]}),languageDropdownOpen\u0026\u0026_jsx(`div`,{className:`mint-absolute mint-top-full mint-left-0 mint-mt-2 mint-w-full mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-300 dark:mint-border-gray-600 mint-rounded-lg mint-shadow-lg mint-z-50 mint-max-h-64 mint-overflow-y-auto`,children:allLanguages.map(lang=>_jsx(`button`,{onClick:()=>{setSelectedLanguage(lang);setLanguageDropdownOpen(false)},className:`mint-w-full mint-text-left mint-px-4 mint-py-2.5 mint-text-sm hover:mint-bg-gray-100 dark:hover:mint-bg-gray-700 mint-transition-colors ${selectedLanguage===lang?`mint-bg-blue-50 dark:mint-bg-blue-900/20 mint-text-blue-600 dark:mint-text-blue-400 mint-font-medium`:`mint-text-gray-700 dark:mint-text-gray-200`}`,children:lang},lang))})]}),_jsxs(`div`,{className:`mint-relative`,children:[_jsxs(`button`,{onClick:()=>{setTagDropdownOpen(!tagDropdownOpen);setLanguageDropdownOpen(false)},className:`mint-flex mint-items-center mint-justify-between mint-gap-3 mint-px-4 mint-py-2.5 mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-300 dark:mint-border-gray-600 mint-rounded-lg hover:mint-border-gray-400 dark:hover:mint-border-gray-500 mint-transition-colors mint-min-w-[180px]`,children:[_jsx(`span`,{className:`mint-text-sm mint-text-gray-700 dark:mint-text-gray-200`,children:selectedTag}),_jsx(`svg`,{xmlns:`http://www.w3.org/2000/svg`,width:`12`,height:`8`,fill:`none`,className:`mint-transition-transform ${tagDropdownOpen?`mint-rotate-180`:``}`,children:_jsx(`path`,{fill:`currentColor`,fillRule:`evenodd`,d:`m6.644 5.76808 4.34-3.766.75-.651996c.08352-.067492.15088-.152810.19716-.249704.04628-.096896.07030-.202916.07030-.310296 0-.107379-.02402-.213399-.07030-.310295C11.88488.382894 11.81752.297576 11.734.230084c-.18088-.151486-.41008-.233093-.646-.22999963H.912C.408.00008474 0 .354084 0 .790084c0 .21.096.412.266.56l.77.667996 4.32 3.75c.18130.14956.40898.23136.644.23136s.46270-.0818.644-.23136Z`,clipRule:`evenodd`})})]}),tagDropdownOpen\u0026\u0026_jsx(`div`,{className:`mint-absolute mint-top-full mint-left-0 mint-mt-2 mint-w-full mint-bg-white dark:mint-bg-gray-800 mint-border mint-border-gray-300 dark:mint-border-gray-600 mint-rounded-lg mint-shadow-lg mint-z-50 mint-max-h-64 mint-overflow-y-auto`,children:allTags.map(tag=>_jsx(`button`,{onClick:()=>{setSelectedTag(tag);setTagDropdownOpen(false)},className:`mint-w-full mint-text-left mint-px-4 mint-py-2.5 mint-text-sm hover:mint-bg-gray-100 dark:hover:mint-bg-gray-700 mint-transition-colors ${selectedTag===tag?`mint-bg-blue-50 dark:mint-bg-blue-900/20 mint-text-blue-600 dark:mint-text-blue-400 mint-font-medium`:`mint-text-gray-700 dark:mint-text-gray-200`}`,children:tag},tag))})]}),hasActiveFilters\u0026\u0026_jsx(`button`,{onClick:resetFilters,className:`mint-px-4 mint-py-2.5 mint-text-sm mint-text-blue-600 dark:mint-text-blue-400 hover:mint-text-blue-700 dark:hover:mint-text-blue-300 mint-font-medium mint-transition-colors`,children:`Reset filters`})]}),_jsx(`div`,{className:`mint-grid mint-grid-cols-1 md:mint-grid-cols-2 lg:mint-grid-cols-3 mint-gap-6`,children:filteredSamples.map((sample,index)=>_jsxs(_components.a,{href:sample.href,target:`_blank`,rel:`noreferrer noopener`,className:`mint-flex mint-flex-col mint-p-6 mint-rounded-lg mint-border mint-border-gray-200 dark:mint-border-gray-700 mint-bg-white dark:mint-bg-gray-900 hover:mint-border-blue-500 dark:hover:mint-border-blue-400 hover:mint-shadow-lg mint-transition-all mint-duration-200 mint-cursor-pointer`,children:[_jsx(`div`,{className:`mint-w-12 mint-h-12 mint-rounded-lg mint-flex mint-items-center mint-justify-center mint-mb-4`,children:_jsx(`img`,{src:sample.icon,alt:sample.languages.join(`, `),className:`mint-w-12 mint-h-12 mint-my-0`})}),_jsx(`h3`,{className:`mint-text-lg mint-font-semibold mint-text-gray-900 dark:mint-text-white mint-mb-4`,children:sample.title}),_jsx(`div`,{className:`mint-flex mint-flex-wrap mint-gap-2 mint-mt-auto`,children:sample.tags.map((tag,tagIndex)=>_jsx(`span`,{className:`mint-px-2.5 mint-py-1 mint-rounded-full mint-text-xs mint-font-semibold mint-uppercase mint-tracking-wide mint-text-gray-900 mint-bg-gray-200 dark:mint-bg-gray-700 dark:mint-text-gray-100`,children:tag},tagIndex))})]},index))}),filteredSamples.length===0\u0026\u0026_jsxs(`div`,{className:`mint-text-center mint-py-12`,children:[_jsx(`p`,{className:`mint-text-gray-600 dark:mint-text-gray-400 mint-text-lg`,children:translate(`No samples found matching your filters.`)}),_jsx(`button`,{onClick:resetFilters,className:`mint-mt-4 mint-px-6 mint-py-2.5 mint-bg-blue-600 hover:mint-bg-blue-700 mint-text-white mint-rounded-lg mint-font-medium mint-transition-colors`,children:translate(`Clear filters`)})]})]})};function _createMdxContent(props){const{_MdxComponentBoundary}={..._provideComponents(),...props.components};if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsx(_MdxComponentBoundary,{name:`SampleCodeCatalog`,children:_jsx(SampleCodeCatalog,{})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{SampleCodeCatalog,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"description":"Box API、SDK、およびUI Elementsのサンプルコードとデモアプリケーションを確認する","mode":"wide","title":"サンプルコードカタログ","href":"/ja/sample-code"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[27,38,""],[137,26886,"null;function _creat"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/box/523776d2eff70e58/scripts/cookie-banner.js","/_mintlify/custom/box/e597cec886c1778e/scripts/locale-links.js","/_mintlify/custom/box/37b2f846ed414abc/snippets/choose-choice-simple.js","/_mintlify/custom/box/78fc14bb599966cb/scripts/locale-footer-combined.js","/_mintlify/custom/box/9a429216167d598a/scripts/analitics.js","/_mintlify/custom/box/2f463a090bfcd0e8/snippets/boxIntl.js","/_mintlify/custom/box/22156a3cb7d763bc/snippets/translations.js","/_mintlify/custom/box/d67e74fc334b686a/scripts/preferred-source.js"],"dynamicCss":".mint-absolute {\n position: absolute\n}\n.mint-relative {\n position: relative\n}\n.mint-left-0 {\n left: 0px\n}\n.mint-top-full {\n top: 100%\n}\n.mint-z-20 {\n z-index: 20\n}\n.mint-z-50 {\n z-index: 50\n}\n.mint-mx-auto {\n margin-left: auto;\n margin-right: auto\n}\n.mint-my-0 {\n margin-top: 0px;\n margin-bottom: 0px\n}\n.mint-mb-4 {\n margin-bottom: 1rem\n}\n.mint-mb-8 {\n margin-bottom: 2rem\n}\n.mint-mt-2 {\n margin-top: 0.5rem\n}\n.mint-mt-4 {\n margin-top: 1rem\n}\n.mint-mt-auto {\n margin-top: auto\n}\n.mint-flex {\n display: flex\n}\n.mint-grid {\n display: grid\n}\n.mint-h-12 {\n height: 3rem\n}\n.mint-max-h-64 {\n max-height: 16rem\n}\n.mint-w-12 {\n width: 3rem\n}\n.mint-w-full {\n width: 100%\n}\n.mint-min-w-\\[180px\\] {\n min-width: 180px\n}\n.mint-max-w-\\[1400px\\] {\n max-width: 1400px\n}\n.mint-rotate-180 {\n --tw-rotate: 180deg;\n transform: translate(var(--tw-translate-x), var(--tw-translate-y)) rotate(var(--tw-rotate)) skewX(var(--tw-skew-x)) skewY(var(--tw-skew-y)) scaleX(var(--tw-scale-x)) scaleY(var(--tw-scale-y))\n}\n.mint-cursor-pointer {\n cursor: pointer\n}\n.mint-grid-cols-1 {\n grid-template-columns: repeat(1, minmax(0, 1fr))\n}\n.mint-flex-col {\n flex-direction: column\n}\n.mint-flex-wrap {\n flex-wrap: wrap\n}\n.mint-items-center {\n align-items: center\n}\n.mint-justify-center {\n justify-content: center\n}\n.mint-justify-between {\n justify-content: space-between\n}\n.mint-gap-2 {\n gap: 0.5rem\n}\n.mint-gap-3 {\n gap: 0.75rem\n}\n.mint-gap-6 {\n gap: 1.5rem\n}\n.mint-overflow-y-auto {\n overflow-y: auto\n}\n.mint-rounded-full {\n border-radius: 9999px\n}\n.mint-rounded-lg {\n border-radius: 0.5rem\n}\n.mint-border {\n border-width: 1px\n}\n.mint-border-gray-200 {\n --tw-border-opacity: 1;\n border-color: rgb(229 231 235 / var(--tw-border-opacity, 1))\n}\n.mint-border-gray-300 {\n --tw-border-opacity: 1;\n border-color: rgb(209 213 219 / var(--tw-border-opacity, 1))\n}\n.mint-bg-blue-50 {\n --tw-bg-opacity: 1;\n background-color: rgb(239 246 255 / var(--tw-bg-opacity, 1))\n}\n.mint-bg-blue-600 {\n --tw-bg-opacity: 1;\n background-color: rgb(37 99 235 / var(--tw-bg-opacity, 1))\n}\n.mint-bg-gray-200 {\n --tw-bg-opacity: 1;\n background-color: rgb(229 231 235 / var(--tw-bg-opacity, 1))\n}\n.mint-bg-white {\n --tw-bg-opacity: 1;\n background-color: rgb(255 255 255 / var(--tw-bg-opacity, 1))\n}\n.mint-p-6 {\n padding: 1.5rem\n}\n.mint-px-2\\.5 {\n padding-left: 0.625rem;\n padding-right: 0.625rem\n}\n.mint-px-4 {\n padding-left: 1rem;\n padding-right: 1rem\n}\n.mint-px-6 {\n padding-left: 1.5rem;\n padding-right: 1.5rem\n}\n.mint-py-1 {\n padding-top: 0.25rem;\n padding-bottom: 0.25rem\n}\n.mint-py-12 {\n padding-top: 3rem;\n padding-bottom: 3rem\n}\n.mint-py-2\\.5 {\n padding-top: 0.625rem;\n padding-bottom: 0.625rem\n}\n.mint-text-left {\n text-align: left\n}\n.mint-text-center {\n text-align: center\n}\n.mint-text-lg {\n font-size: 1.125rem;\n line-height: 1.75rem\n}\n.mint-text-sm {\n font-size: 0.875rem;\n line-height: 1.25rem\n}\n.mint-text-xs {\n font-size: 0.75rem;\n line-height: 1rem\n}\n.mint-font-medium {\n font-weight: 500\n}\n.mint-font-semibold {\n font-weight: 600\n}\n.mint-uppercase {\n text-transform: uppercase\n}\n.mint-tracking-wide {\n letter-spacing: 0.025em\n}\n.mint-text-blue-600 {\n --tw-text-opacity: 1;\n color: rgb(37 99 235 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-600 {\n --tw-text-opacity: 1;\n color: rgb(75 85 99 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-700 {\n --tw-text-opacity: 1;\n color: rgb(55 65 81 / var(--tw-text-opacity, 1))\n}\n.mint-text-gray-900 {\n --tw-text-opacity: 1;\n color: rgb(17 24 39 / var(--tw-text-opacity, 1))\n}\n.mint-text-white {\n --tw-text-opacity: 1;\n color: rgb(255 255 255 / var(--tw-text-opacity, 1))\n}\n.mint-shadow-lg {\n --tw-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);\n --tw-shadow-colored: 0 10px 15px -3px var(--tw-shadow-color), 0 4px 6px -4px var(--tw-shadow-color);\n box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow)\n}\n.mint-transition-all {\n transition-property: all;\n transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);\n transition-duration: 150ms\n}\n.mint-transition-colors {\n transition-property: color, background-color, border-color, text-decoration-color, fill, stroke;\n transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);\n transition-duration: 150ms\n}\n.mint-transition-transform {\n transition-property: transform;\n transition-timing-function: cubic-bezier(0.4, 0, 0.2, 1);\n transition-duration: 150ms\n}\n.mint-duration-200 {\n transition-duration: 200ms\n}\n.hover\\:mint-border-blue-500:hover {\n --tw-border-opacity: 1;\n border-color: rgb(59 130 246 / var(--tw-border-opacity, 1))\n}\n.hover\\:mint-border-gray-400:hover {\n --tw-border-opacity: 1;\n border-color: rgb(156 163 175 / var(--tw-border-opacity, 1))\n}\n.hover\\:mint-bg-blue-700:hover {\n --tw-bg-opacity: 1;\n background-color: rgb(29 78 216 / var(--tw-bg-opacity, 1))\n}\n.hover\\:mint-bg-gray-100:hover {\n --tw-bg-opacity: 1;\n background-color: rgb(243 244 246 / var(--tw-bg-opacity, 1))\n}\n.hover\\:mint-text-blue-700:hover {\n --tw-text-opacity: 1;\n color: rgb(29 78 216 / var(--tw-text-opacity, 1))\n}\n.hover\\:mint-shadow-lg:hover {\n --tw-shadow: 0 10px 15px -3px rgb(0 0 0 / 0.1), 0 4px 6px -4px rgb(0 0 0 / 0.1);\n --tw-shadow-colored: 0 10px 15px -3px var(--tw-shadow-color), 0 4px 6px -4px var(--tw-shadow-color);\n box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow)\n}\n.dark\\:mint-border-gray-600:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(75 85 99 / var(--tw-border-opacity, 1))\n}\n.dark\\:mint-border-gray-700:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(55 65 81 / var(--tw-border-opacity, 1))\n}\n.dark\\:mint-bg-blue-900\\/20:is(.dark *) {\n background-color: rgb(30 58 138 / 0.2)\n}\n.dark\\:mint-bg-gray-700:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(55 65 81 / var(--tw-bg-opacity, 1))\n}\n.dark\\:mint-bg-gray-800:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(31 41 55 / var(--tw-bg-opacity, 1))\n}\n.dark\\:mint-bg-gray-900:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(17 24 39 / var(--tw-bg-opacity, 1))\n}\n.dark\\:mint-text-blue-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(96 165 250 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-100:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(243 244 246 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-200:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(229 231 235 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-gray-400:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(156 163 175 / var(--tw-text-opacity, 1))\n}\n.dark\\:mint-text-white:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(255 255 255 / var(--tw-text-opacity, 1))\n}\n.dark\\:hover\\:mint-border-blue-400:hover:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(96 165 250 / var(--tw-border-opacity, 1))\n}\n.dark\\:hover\\:mint-border-gray-500:hover:is(.dark *) {\n --tw-border-opacity: 1;\n border-color: rgb(107 114 128 / var(--tw-border-opacity, 1))\n}\n.dark\\:hover\\:mint-bg-gray-700:hover:is(.dark *) {\n --tw-bg-opacity: 1;\n background-color: rgb(55 65 81 / var(--tw-bg-opacity, 1))\n}\n.dark\\:hover\\:mint-text-blue-300:hover:is(.dark *) {\n --tw-text-opacity: 1;\n color: rgb(147 197 253 / var(--tw-text-opacity, 1))\n}\n@media (min-width: 768px) {\n .md\\:mint-grid-cols-2 {\n grid-template-columns: repeat(2, minmax(0, 1fr))\n }\n}\n@media (min-width: 1024px) {\n .lg\\:mint-grid-cols-3 {\n grid-template-columns: repeat(3, minmax(0, 1fr))\n }\n}","subdomain":"box","siteName":"Box Dev Docs","title":"サンプルコードカタログ - Box Dev Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/ja/sample-code","matchLevel":0},"ja":{"href":"/ja","matchLevel":4}}},"lastModified":"2026-09-09T14:01:28.972Z","gitLastModified":"2026-03-20T12:32:43.000Z","originalFileLocation":"ja/sample-code.mdx","locale":"en"},"headHtml":"\u003cmeta data-mint-head name=\"description\" content=\"Box API、SDK、およびUI Elementsのサンプルコードとデモアプリケーションを確認する\">\u003cmeta data-mint-head name=\"application-name\" content=\"Box Dev Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"サンプルコードカタログ - Box Dev Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Box API、SDK、およびUI Elementsのサンプルコードとデモアプリケーションを確認する\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Box Dev Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.box.com/ja/sample-code\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"サンプルコードカタログ - Box Dev Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Box API、SDK、およびUI Elementsのサンプルコードとデモアプリケーションを確認する\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/box/ZCmC4_xrCUAVE-ZZ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Box Dev Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0061d5\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"fuelbNhVR1kQluNBJjYt4K1Hj5HvJLhLnIq0o9CAY9E\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.box.com/ja/sample-code\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/ja/sample-code.md\">","siteName":"Box Dev Docs","nav":{"global":null,"languages":[{"language":"en","banner":{"content":"Join BoxWorks Dev Summit on Nov 5-6, San Francisco and dive into AI agents and unstructured content. [See agenda](https://boxworks.box.com/series/boxworks-2026-dev-summit/landing_page).","dismissible":true},"footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"Resources","items":[{"label":"Newsletter unsubscribe","href":"https://go.box.com/preferences.html"},{"label":"Terms of Use","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"Privacy Policy","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookie Notification","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"Log in","type":"button"}],"primary":{"type":"button","label":"Get started for free","href":"https://account.box.com/signup/developer"}},"tabs":[{"tab":"Home","pages":[{"title":"Home","sidebarTitle":"Box Dev Docs","description":"Build with the Box Platform. Explore guides, API reference, SDKs, and tutorials for content management, Box AI, e-signatures, and enterprise integrations.","mode":"frame","timestamp":false,"href":""},{"title":"Sample Code Catalog","mode":"wide","description":"Explore sample code and demo applications for Box APIs, SDKs, and UI Elements","href":"/sample-code"},{"group":"Getting started","pages":[{"title":"Box for Developers quick start","sidebarTitle":"Quick Start","description":"Sign up for a Box free developer account, generate the developer token and make your first API call.","href":"/guides/getting-started/index"},{"centered":true,"sidebarTitle":"Free developer plan","title":"Free developer plan","description":"Build and test full-featured Box applications at no cost with a free developer plan.","href":"/guides/getting-started/free-developer-plan"},{"title":"Why Box for developers","sidebarTitle":"Why Box","description":"Learn when to use Box to build applications, AI agents, and workflows on governed enterprise content.","href":"/guides/getting-started/why-box"},{"title":"Plan your integration","sidebarTitle":"Plan your integration","description":"Assess whether your use case fits Box, then choose the application type that matches how your app runs.","href":"/guides/getting-started/plan-your-integration"},{"title":"User types","sidebarTitle":"User types","description":"Learn which Box user type your app authenticates as, and how Managed Users, Service Accounts, and App Users differ.","href":"/guides/getting-started/users"},{"title":"Create your first application","sidebarTitle":"Create your first application","description":"Create, configure, and publish (optional) your first application.","href":"/guides/getting-started/first-application"},{"title":"Locating IDs","sidebarTitle":"Locating IDs","description":"Find user IDs, enterprise IDs, and file or folder IDs in the Box web app, Admin Console, Developer Console, and API.","href":"/guides/getting-started/locating-values"},{"title":"Box developer sandboxes","sidebarTitle":"Sandboxes","description":"Build, test, and collaborate on Box applications in an isolated developer sandbox that mirrors your enterprise plan and add-ons.","href":"/guides/getting-started/sandbox"},{"centered":true,"title":"Box for Developers glossary","description":null,"href":"/guides/getting-started/box-glossary"},{"title":"Box Platform API agent playbook","description":"Authentication, core endpoints, SDKs, rate limits, and usage instructions for coding agents integrating with the Box API.","href":"/guides/getting-started/agent-playbook"}]},{"group":"Applications \u0026 integrations","pages":[{"title":"Applications","sidebarTitle":"Overview","description":null,"href":"/guides/applications/index"},{"title":"Integrations","description":null,"href":"/guides/applications/integrations/index"},{"group":"Platform Apps","pages":[{"title":"Platform App","description":null,"href":"/guides/applications/platform-apps/index"},{"title":"Create a Platform App","description":null,"href":"/guides/applications/platform-apps/create"}]},{"group":"Web App Integrations","pages":[{"title":"Web App Integration","description":null,"href":"/guides/applications/web-app-integrations/index"},{"title":"Integrations Types","description":null,"href":"/guides/applications/web-app-integrations/types"},{"title":"User Experience","description":null,"href":"/guides/applications/web-app-integrations/user-experience"},{"title":"Create Web App Integration","description":null,"href":"/guides/applications/web-app-integrations/configure"}]},{"group":"Slack integration mappings","pages":[{"title":"Slack Integration Mappings","sidebarTitle":"Overview","description":null,"href":"/guides/integration-mappings/slack-mappings/index"},{"title":"Slack Integration Mappings Setup","description":null,"href":"/guides/integration-mappings/slack-mappings/setup"},{"title":"List Slack Integration Mappings","description":null,"href":"/guides/integration-mappings/slack-mappings/list-mappings"},{"title":"Create Slack Integration Mapping","description":null,"href":"/guides/integration-mappings/slack-mappings/create-mapping"},{"title":"Update Slack Integration Mapping","description":null,"href":"/guides/integration-mappings/slack-mappings/update-mapping"},{"title":"Delete Slack Integration Mapping","description":null,"href":"/guides/integration-mappings/slack-mappings/delete-mapping"},{"title":"Slack Integration Mappings Troubleshooting","description":null,"href":"/guides/integration-mappings/slack-mappings/troubleshooting"}]},{"group":"Teams integration mappings","pages":[{"title":"Teams integration mappings","sidebarTitle":"Overview","description":null,"href":"/guides/integration-mappings/teams-mappings/index"},{"title":"List Teams integration mappings","description":null,"href":"/guides/integration-mappings/teams-mappings/list-mappings"},{"title":"Create Teams integration mappings","description":null,"href":"/guides/integration-mappings/teams-mappings/create-mappings"},{"title":"Update Teams integration mappings","description":null,"href":"/guides/integration-mappings/teams-mappings/update-mappings"},{"title":"Delete Teams integration mappings","description":null,"href":"/guides/integration-mappings/teams-mappings/delete-mappings"}]}]},{"group":"Identity \u0026 access","pages":[{"group":"Authentication","pages":[{"title":"Authentication","sidebarTitle":"Overview","description":"Compare Box authentication methods, see which credentials and files each one needs, and learn what the access token you get back represents.","href":"/guides/authentication/index"},{"group":"OAuth 2.0","pages":[{"title":"OAuth 2.0 authentication","sidebarTitle":"Overview","description":"How the OAuth 2.0 flow works on Box, from the authorization URL to the access token your app uses on behalf of a signed-in user.","href":"/guides/authentication/oauth2/index"},{"title":"Setup with OAuth 2.0","description":"Create a User app in the Developer Console and configure its redirect URI, scopes, and CORS domains for OAuth 2.0.","href":"/guides/authentication/oauth2/oauth2-setup"},{"title":"OAuth 2.0 with SDKs","description":"Walk through the OAuth 2.0 flow using a Box SDK, from configuring the client to exchanging the authorization code for a token.","href":"/guides/authentication/oauth2/with-sdk"},{"title":"OAuth 2.0 without SDKs","description":"Build the authorization URL, redirect the user, and exchange the authorization code for an access token with direct API calls.","href":"/guides/authentication/oauth2/without-sdk"},{"title":"as-user header","description":"Act on behalf of another user from an OAuth 2.0 app, and the Developer Console settings and permissions this requires.","href":"/guides/authentication/oauth2/as-user"}]},{"group":"Client Credentials Grant","pages":[{"title":"Client Credentials Grant","sidebarTitle":"Overview","description":"How Client Credentials Grant authenticates a Server app with a client ID and client secret, and which subjects it can request a token for.","href":"/guides/authentication/client-credentials/index"},{"title":"Setup with Client Credentials Grant","description":"Create a Server app with Client Credentials Grant, configure its access level and scopes, and request an access token.","href":"/guides/authentication/client-credentials/client-credentials-setup"}]},{"group":"JWT","pages":[{"title":"JWT authentication","sidebarTitle":"Overview","description":"How server-side JWT authentication works on Box, from signing an assertion with your private key to receiving a Service Account token.","href":"/guides/authentication/jwt/index"},{"title":"Setup with JWT","description":"Create a Server app with JWT, generate or upload a public/private keypair, and configure access level, scopes, and CORS domains.","href":"/guides/authentication/jwt/jwt-setup"},{"title":"JWT with SDKs","description":"Read a config.json file and initialize a Box SDK client that handles JWT assertions and token renewal for you.","href":"/guides/authentication/jwt/with-sdk"},{"title":"JWT without SDKs","description":"Decrypt your private key, build and sign a JWT assertion, and exchange it for an access token without using a Box SDK.","href":"/guides/authentication/jwt/without-sdk"},{"title":"as-user header","description":"Act on behalf of another user from a JWT app, including the required app settings, permissions, and known limitations.","href":"/guides/authentication/jwt/as-user"},{"title":"User access tokens","description":"Request an access token that belongs to a specific user instead of the Service Account, with and without the Box SDKs.","href":"/guides/authentication/jwt/user-access-tokens"}]},{"title":"Switch between CCG and JWT","description":"Check whether your enterprise allows changing a Server app's authentication method, and see what a switch revokes and what it preserves.","href":"/guides/authentication/switch-server-auth-type"},{"group":"Tokens","pages":[{"title":"Tokens","sidebarTitle":"Overview","description":"Compare Box access, refresh, and developer tokens and choose the right token for OAuth, JWT, or Developer Console testing.","href":"/guides/authentication/tokens/index"},{"title":"Access tokens","description":"What Box returns in the token object for OAuth 2.0 and for server authentication, and how the two responses differ.","href":"/guides/authentication/tokens/access-tokens"},{"title":"Use a token","description":"Pass an access token in the Authorization header of a Box API call, and check which user the token represents.","href":"/guides/authentication/tokens/api-calls"},{"title":"Refresh a token","description":"Exchange a refresh token for a new access token, and understand the 60-day, single-use limits on refresh tokens.","href":"/guides/authentication/tokens/refresh"},{"title":"Revoke a token","description":"Invalidate an access token or a refresh token with the revoke endpoint, in cURL and in the Box SDKs.","href":"/guides/authentication/tokens/revoke"},{"title":"Downscope a token","description":"Exchange an access token for a more restricted one before you pass it to a browser, a mobile app, or Box UI Elements.","href":"/guides/authentication/tokens/downscope"},{"title":"Use a token in SDKs","description":"Pass an existing access token or a developer token straight to a Box SDK client instead of configuring a full authentication flow.","href":"/guides/authentication/tokens/sdks"},{"title":"Developer tokens","description":"Generate a short-lived Box developer token in the Developer Console to test API calls during development. Tokens expire after 60 minutes.","href":"/guides/authentication/tokens/developer-tokens"},{"title":"Annotator tokens","description":"Generate an access token that ties Box View annotations to one of your own end users, with or without an SDK.","href":"/guides/authentication/tokens/annotator-tokens"}]},{"title":"Box API and SSO","sidebarTitle":"Enterprise SSO","description":"How single sign-on affects OAuth 2.0 sign-ins, and why it doesn't apply to server-side authentication.","href":"/guides/authentication/sso"},{"title":"Authentication best practices","sidebarTitle":"Best practices","description":"Practical guidance on protecting your client secret, caching and refreshing access tokens, downscoping, and revoking tokens.","href":"/guides/authentication/best-practices"}]},{"group":"Authorization","pages":[{"title":"Authorization","sidebarTitle":"Overview","description":null,"href":"/guides/authorization/index"},{"title":"Platform app approval","description":"Authorize or enable Box Platform apps in the Admin Console, submit apps for admin approval, and re-authorize apps after scope or access changes.","href":"/guides/authorization/platform-app-approval"},{"title":"Limited Access App Approval","description":null,"href":"/guides/authorization/limited-access-approval"},{"title":"Common Errors","description":null,"href":"/guides/authorization/common-errors"}]},{"group":"SSO \u0026 App users","pages":[{"title":"SSO \u0026 App users","description":"How to use your own SSO service as the identity source for an app and link those identities to Box App Users.","href":"/guides/sso-identities-and-app-users/index"},{"group":"Connect Okta identities to Box App Users in a web app","pages":[{"title":"Connect Okta identities to Box App Users in a web app","type":"quick-start","hide_step_number":true,"hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/index"},{"title":"Scaffold application code (Okta integration)","sidebarTitle":"1. Scaffold application code","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/scaffold-application-code"},{"title":"Configure Okta","sidebarTitle":"2. Configure Okta","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/configure-okta"},{"title":"Configure Box (Okta integration)","sidebarTitle":"3. Configure Box","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/configure-box"},{"title":"Logging into the app with Okta","sidebarTitle":"4. Logging into the app with Okta","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/logging-into-app"},{"title":"Find or create Box app users","sidebarTitle":"5. Find or create Box app users","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/find-or-create-box-users"},{"title":"Run the application","sidebarTitle":"6. Run the application","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/sso-identities-and-app-users/connect-okta-to-app-users/run-the-app"}]},{"title":"Connect SSO identities to app users","description":null,"href":"/guides/sso-identities-and-app-users/connect-identities"},{"title":"Create connection between SSO identity and app user","description":null,"href":"/guides/sso-identities-and-app-users/create-app-user"},{"title":"Find app user for SSO identity","description":null,"href":"/guides/sso-identities-and-app-users/find-app-user"}]}]},{"group":"Using the API","pages":[{"title":"API Calls","sidebarTitle":"Overview","description":"Learn how to make calls to the Box REST API, including authentication headers, common patterns, and platform insights.","href":"/guides/api-calls/index"},{"title":"Types and formats","description":null,"href":"/guides/api-calls/types-and-formats"},{"title":"Status codes","description":null,"href":"/guides/api-calls/status-codes"},{"title":"Sorting responses","description":null,"href":"/guides/api-calls/sorting"},{"title":"Request extra fields","description":"Learn about standard, mini, and full resource variants in the Box API, and how to use the fields query parameter to request additional fields.","href":"/guides/api-calls/request-extra-fields"},{"title":"Ensure consistency with headers","description":null,"href":"/guides/api-calls/ensure-consistency"},{"title":"Allow domain access","description":null,"href":"/guides/api-calls/allowing-domain-access"},{"title":"Suppress notifications","description":null,"href":"/guides/api-calls/suppress-notifications"},{"title":"Language codes","description":null,"href":"/guides/api-calls/language-codes"},{"title":"API versioning strategy","description":null,"href":"/guides/api-calls/api-versioning-strategy"},{"group":"Pagination","pages":[{"title":"Pagination overview","sidebarTitle":"Overview","description":null,"href":"/guides/api-calls/pagination/index"},{"title":"Box API offset-based pagination","sidebarTitle":"Offset-based","description":"Page Box API collections with `offset` and `limit`. This includes limits of offset-based pagination, and when to use marker-based paging instead.","href":"/guides/api-calls/pagination/offset-based"},{"title":"Marker-based Pagination","description":null,"href":"/guides/api-calls/pagination/marker-based"}]},{"group":"Permissions and errors","pages":[{"title":"Box API errors","sidebarTitle":"Errors","description":"Look up Box API HTTP errors, JSON error responses, and common 4xx and 5xx codes when a request fails.","href":"/guides/api-calls/permissions-and-errors/common-errors"},{"title":"Box API rate limits","sidebarTitle":"Rate limits","description":"Understand Box API rate limits, 429 responses, and how to retry requests without exceeding per-user and enterprise quotas.","href":"/guides/api-calls/permissions-and-errors/rate-limits"},{"title":"Box API scopes","sidebarTitle":"Scopes","description":"Configure Box application scopes in the Developer Console so your app can call only the API endpoints it needs.","href":"/guides/api-calls/permissions-and-errors/scopes"},{"title":"Token \u0026 URL Expiration","description":null,"href":"/guides/api-calls/permissions-and-errors/expiration"},{"title":"Versioning errors","description":null,"href":"/guides/api-calls/permissions-and-errors/versioning-errors"}]}]},{"group":"Troubleshooting","pages":[{"title":"Debugging your Box app","description":"A step-by-step playbook for diagnosing failed API calls, handling retries and timeouts, and using the App Diagnostics tool to troubleshoot your Box application.","href":"/guides/troubleshooting/debugging-your-box-app"},{"title":"App Diagnostics Report","description":null,"href":"/guides/troubleshooting/app-diagnostics-report"}]},{"group":"Content","pages":[{"group":"Files","pages":[{"title":"Get File Information","description":null,"href":"/guides/files/get"},{"title":"File limitations","sidebarTitle":"Limitations","description":null,"href":"/guides/files/limitations"}]},{"group":"Folders","pages":[{"title":"Create Folder","description":null,"href":"/guides/folders/single/create"},{"title":"Update Folder","description":null,"href":"/guides/folders/single/update"},{"title":"Rename Folder","description":null,"href":"/guides/folders/single/rename"},{"title":"Move Folder","description":null,"href":"/guides/folders/single/move"},{"title":"Copy Folder","description":null,"href":"/guides/folders/single/copy"},{"title":"Delete Folder","description":null,"href":"/guides/folders/single/delete"},{"title":"Change Folder Owner","description":null,"href":"/guides/folders/single/change-owner"},{"title":"Create Folder Lock","description":null,"href":"/guides/folders/single/create-lock"},{"title":"Get Folder Lock","description":null,"href":"/guides/folders/single/get-locks"},{"title":"Delete Folder Lock","description":null,"href":"/guides/folders/single/delete-lock"},{"title":"Build Folder Tree","description":null,"href":"/guides/folders/bulk/build-folder-tree"}]},{"group":"Uploads","pages":[{"title":"Uploads","sidebarTitle":"Overview","description":"Upload files to Box using direct upload for files up to 50 MB or chunked upload for larger files with retry control.","href":"/guides/uploads/index"},{"title":"Preflight Check","related_pages":[],"description":null,"href":"/guides/uploads/check"},{"group":"Direct Uploads","pages":[{"title":"Direct Uploads","sidebarTitle":"Overview","description":null,"href":"/guides/uploads/direct/index"},{"title":"Upload New File","related_pages":[],"description":null,"href":"/guides/uploads/direct/file"},{"title":"Upload File Version","related_pages":[],"description":null,"href":"/guides/uploads/direct/file-version"}]},{"group":"Chunked Uploads","pages":[{"title":"Chunked Uploads","sidebarTitle":"Overview","description":null,"href":"/guides/uploads/chunked/index"},{"title":"Create Upload Session","related_pages":[],"description":null,"href":"/guides/uploads/chunked/create-session"},{"title":"Chunked Upload with SDKs","related_pages":[],"description":null,"href":"/guides/uploads/chunked/with-sdks"},{"title":"Upload Part","description":"Upload each part of a large file to a chunked upload session, using a SHA-1 or SHA-512 digest to verify the content.","related_pages":[],"href":"/guides/uploads/chunked/upload-part"},{"title":"Commit Upload Session","description":"Commit a chunked upload session to create a file from the uploaded parts, including parts the server already has.","related_pages":[],"href":"/guides/uploads/chunked/commit-session"},{"title":"Upload All Files in Folder","related_pages":[],"description":null,"href":"/guides/uploads/chunked/folder"}]},{"group":"Tutorials","pages":[{"title":"Upload methods with Python","description":"Learn how to upload files to Box with the Python SDK by using direct upload and chunked upload, including the `upload_big_file` convenience method, manual upload sessions, preflight checks, and conflict handling.","href":"/guides/uploads/tutorials/upload-methods-python"},{"title":"Recursively upload a folder with Python","description":"Learn how to upload a local folder tree to Box with a recursive Python script that creates folders, uploads files, and handles naming conflicts.","href":"/guides/uploads/tutorials/recursive-folder-upload-python"}]}]},{"group":"Downloads","pages":[{"title":"Downloads","sidebarTitle":"Overview","description":"Download files from Box to your application server or directly to a browser, and understand access requirements.","href":"/guides/downloads/index"},{"title":"Download File","description":null,"href":"/guides/downloads/file"},{"title":"Download File Version","description":null,"href":"/guides/downloads/file-version"},{"title":"Get Download URL","description":null,"href":"/guides/downloads/get-url"},{"title":"Download Shared Link","description":null,"href":"/guides/downloads/shared-link"},{"title":"Download All Files in Folder using SDKs","description":null,"href":"/guides/downloads/folder"},{"title":"Download in Browser","description":null,"href":"/guides/downloads/in-browser"},{"title":"Download ZIP Archive","description":null,"href":"/guides/downloads/zip-archive"}]},{"group":"Web Links","pages":[{"title":"Web Links","sidebarTitle":"Overview","description":null,"href":"/guides/web-links/index"},{"title":"Create Web Link","description":null,"href":"/guides/web-links/create"},{"title":"Delete Web Link","description":null,"href":"/guides/web-links/delete"}]},{"group":"Trash","pages":[{"title":"Trash","sidebarTitle":"Overview","description":null,"href":"/guides/trash/index"},{"title":"Restore File","description":null,"href":"/guides/trash/restore-file"},{"title":"Permanently Delete File","description":null,"href":"/guides/trash/permanently-delete-file"},{"title":"Restore Folder","description":null,"href":"/guides/trash/restore-folder"},{"title":"Permanently Delete Folder","description":null,"href":"/guides/trash/permanently-delete-folder"},{"title":"Restore Web Link","description":null,"href":"/guides/trash/restore-web-link"},{"title":"Permanently Delete Web Link","description":null,"href":"/guides/trash/permanently-delete-web-link"}]},{"group":"Representations","pages":[{"title":"Representations","sidebarTitle":"Overview","description":null,"href":"/guides/representations/index"},{"title":"List All Representations for File","description":null,"href":"/guides/representations/list-all-representations"},{"title":"Request Desired Representation","description":null,"href":"/guides/representations/request-a-representation"},{"title":"Download File Representation","description":null,"href":"/guides/representations/download-a-representation"},{"title":"Get Thumbnail Representation","description":null,"href":"/guides/representations/thumbnail-representation"},{"title":"Get Basic Thumbnail","description":null,"href":"/guides/representations/thumbnail"},{"title":"Get Markdown Representation","description":"Generate and download Markdown representations using the Box API.","href":"/guides/representations/markdown"},{"title":"Get Text Representation","description":null,"href":"/guides/representations/text"},{"title":"Get PDF Representation","description":null,"href":"/guides/representations/pdf"},{"title":"Supported File Types","description":null,"href":"/guides/representations/supported-file-types"}]},{"group":"Box Archive","pages":[{"title":"Box Archive","sidebarTitle":"Overview","description":null,"href":"/guides/archives/index"},{"title":"Add content to Box Archive","description":null,"href":"/guides/archives/add-content"},{"title":"Restore content from Box Archive","description":null,"href":"/guides/archives/restore-content"},{"title":"Supported APIs for Box Archive","description":null,"href":"/guides/archives/supported-apis"}]}]},{"group":"Collaboration","pages":[{"group":"Collaborations","pages":[{"title":"Collaborations","description":"Grant users and groups role-based access to files and folders, manage pending invitations, and apply collaboration domain restrictions.","sidebarTitle":"Overview","href":"/guides/collaborations/index"},{"group":"Connect Slack to Group Collaborations","pages":[{"title":"Connect Slack to Box Group Collaborations","type":"quick-start","hide_step_number":true,"hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/index"},{"title":"Configure Slack","sidebarTitle":"1. Configure Slack","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/configure-slack"},{"title":"Configure Box (Slack integration)","sidebarTitle":"2. Configure Box","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/configure-box"},{"title":"Scaffold application code (Slack integration)","sidebarTitle":"3. Scaffold application code","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/scaffold-application-code"},{"title":"Handle Slack Events","sidebarTitle":"4. Handle Slack Events","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/handle-slack-events"},{"title":"Connect Bot to Box","sidebarTitle":"5. Connect Bot to Box","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/connect-box-functions"},{"title":"Test the bot","sidebarTitle":"6. Test the bot","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/collaborations/connect-slack-to-group-collabs/test-bot"}]},{"title":"Share Content with User","description":null,"href":"/guides/collaborations/share-content"},{"title":"Sharing with Groups","description":null,"href":"/guides/collaborations/groups"},{"title":"Get Pending Collaborations","description":null,"href":"/guides/collaborations/pending"},{"group":"Allowed Domains","pages":[{"title":"Allowed collaboration domains overview","sidebarTitle":"Overview","related_pages":[],"description":null,"href":"/guides/collaborations/allowed-domains/index"},{"title":"Allow a domain for collaboration","related_pages":[],"description":null,"href":"/guides/collaborations/allowed-domains/create"},{"title":"List allowed domains for collaboration","related_pages":[],"description":null,"href":"/guides/collaborations/allowed-domains/list"},{"title":"Remove a previously allowed domain for collaboration","related_pages":[],"description":null,"href":"/guides/collaborations/allowed-domains/delete"}]}]},{"group":"Shared Links","pages":[{"title":"Shared Links","description":"Generate URL-based access to files, folders, and web links stored in Box with configurable access levels.","related_pages":null,"sidebarTitle":"Overview","href":"/guides/shared-links/index"},{"title":"Create or Update Shared Link","related_pages":[],"description":null,"href":"/guides/shared-links/create-or-update"},{"title":"Find Item from Shared Link","related_pages":[],"description":null,"href":"/guides/shared-links/find-for-item"},{"title":"Remove Shared Link","related_pages":[],"description":null,"href":"/guides/shared-links/remove"},{"title":"Shared Link Permissions","related_pages":[],"description":null,"href":"/guides/shared-links/permissions"}]},{"group":"Comments","pages":[{"title":"Comments overview","sidebarTitle":"Overview","description":null,"href":"/guides/comments/index"},{"title":"Create Comment","description":null,"href":"/guides/comments/create-comment"},{"title":"Create Reply","description":null,"href":"/guides/comments/create-reply"}]},{"group":"Tasks","pages":[{"title":"Tasks overview","sidebarTitle":"Overview","description":null,"href":"/guides/tasks/index"},{"title":"Create a task","description":null,"href":"/guides/tasks/create"},{"title":"Get information about a task","description":null,"href":"/guides/tasks/get"},{"title":"Lists all tasks for a file","description":null,"href":"/guides/tasks/for-file"},{"title":"Make changes to an existing task","description":null,"href":"/guides/tasks/update"},{"title":"Delete a task","description":null,"href":"/guides/tasks/delete"},{"group":"Assigning tasks","pages":[{"title":"Assigning tasks","sidebarTitle":"Overview","description":null,"href":"/guides/tasks/assignments/index"},{"title":"Assign a task to a user","description":null,"href":"/guides/tasks/assignments/assign"},{"title":"Unassign a task","description":null,"href":"/guides/tasks/assignments/unassign"},{"title":"Change an assignment's message","description":null,"href":"/guides/tasks/assignments/update-message"},{"title":"Get task assignment information","description":null,"href":"/guides/tasks/assignments/get"},{"title":"List a task's assignments","description":null,"href":"/guides/tasks/assignments/list"},{"title":"Change task assignment state","description":null,"href":"/guides/tasks/assignments/change-state"}]}]},{"group":"Collections","pages":[{"title":"Collections overview","sidebarTitle":"Overview","description":null,"href":"/guides/collections/index"},{"title":"List User's Collections","description":null,"href":"/guides/collections/list"},{"title":"List Items in Collections","description":null,"href":"/guides/collections/list-items"},{"title":"Add Item to Collection","description":null,"href":"/guides/collections/add"},{"title":"Remove Item from Collection","description":null,"href":"/guides/collections/remove"}]},{"group":"File Requests","pages":[{"title":"File Requests","sidebarTitle":"Overview","description":null,"href":"/guides/file-requests/index"},{"title":"Create a template File Request","description":null,"href":"/guides/file-requests/template"},{"title":"Copy a File Request","description":null,"href":"/guides/file-requests/copy"},{"title":"Get information for a File Request","description":null,"href":"/guides/file-requests/get"},{"title":"Update a File Request","description":null,"href":"/guides/file-requests/update"},{"title":"Delete a File Request","description":null,"href":"/guides/file-requests/delete"}]},{"group":"Box Notes","pages":[{"title":"Box Notes API","description":"Programmatically create Box Notes from Markdown content using the Box Notes API.","sidebarTitle":"Overview","href":"/guides/box-notes/index"},{"title":"Get started with Box Notes API","description":"Set up authentication and create your first Box Note from Markdown content.","href":"/guides/box-notes/get-started"},{"title":"Convert Markdown to Box Note","description":"Detailed guide for converting Markdown content to a Box Note using the POST /notes/convert endpoint.","href":"/guides/box-notes/convert-markdown"},{"title":"Box Notes API use cases","description":"Common scenarios and patterns for creating Box Notes programmatically from Markdown content.","href":"/guides/box-notes/use-cases"}]},{"group":"Box Hubs","pages":[{"title":"Box Hubs overview","sidebarTitle":"Overview","description":"Organize files and folders into Box Hubs and query curated, permission-aware content with the Hubs API and Box AI Ask.","href":"/guides/hubs-api/index"},{"title":"Turn an enterprise document repository into an access-controlled AI knowledge base","sidebarTitle":"Access-controlled knowledge base","description":"Build an access-controlled AI knowledge base with Box Hubs and Box AI Ask. Answers inherit Box permissions. No vector database needed.","href":"/guides/hubs-api/access-controlled-knowledge-base"},{"title":"Hubs APIs use cases","description":"Use the Box Hubs API to automate content portals, inherit source-file permissions, and query curated knowledge with Box AI.","href":"/guides/hubs-api/use-cases"},{"group":"Hubs","pages":[{"title":"Create a hub","description":null,"href":"/guides/hubs-api/hubs/create-hub"},{"title":"Get a hub","description":null,"href":"/guides/hubs-api/hubs/get-hub"},{"title":"List hubs","description":null,"href":"/guides/hubs-api/hubs/list-hubs"},{"title":"Update a hub","description":null,"href":"/guides/hubs-api/hubs/update-hub"},{"title":"Delete a hub","description":null,"href":"/guides/hubs-api/hubs/delete-hub"},{"title":"Copy a hub","description":null,"href":"/guides/hubs-api/hubs/copy-hub"}]},{"title":"Manage hub items","description":null,"href":"/guides/hubs-api/hubs-items/hub-items"},{"title":"Manage hub collaborations","description":null,"href":"/guides/hubs-api/hubs-collaborations/hub-collaborations"}]}]},{"group":"Metadata \u0026 search","pages":[{"group":"Metadata","pages":[{"sidebarTitle":"Overview","title":"Metadata","description":"Define and store custom key-value data on files and folders using metadata templates, instances, cascade policies, and queries.","href":"/guides/metadata/index"},{"group":"Working with Metadata","pages":[{"title":"Working with Metadata","type":"quick-start","hide_step_number":true,"hide_in_page_nav":true,"sidebarTitle":"Overview","description":null,"href":"/guides/metadata/quick-start/index"},{"title":"List all metadata templates (quick start)","sidebarTitle":"1. List all metadata templates","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/metadata/quick-start/list-all"},{"title":"Create a custom metadata template","sidebarTitle":"2. Create a custom metadata template","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/metadata/quick-start/create-template"},{"title":"Apply metadata to a file","sidebarTitle":"3. Apply metadata to a file","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/metadata/quick-start/create-instance"},{"title":"Update metadata on a file","sidebarTitle":"4. Update metadata on a file","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/metadata/quick-start/update-instance"},{"title":"Update a metadata template (quick start)","sidebarTitle":"5. Update a metadata template","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/metadata/quick-start/update-template"},{"title":"Create a metadata query","sidebarTitle":"6. Create a metadata query","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/metadata/quick-start/create-query"},{"title":"Metadata quick start: next steps","sidebarTitle":"Next steps","type":"quick-start","hide_step_number":true,"description":null,"href":"/guides/metadata/quick-start/next-steps"}]},{"title":"Metadata template scopes","description":null,"href":"/guides/metadata/scopes"},{"title":"Classifications","description":null,"href":"/guides/metadata/classifications"},{"group":"Metadata templates","pages":[{"title":"Metadata templates overview","sidebarTitle":"Overview","description":null,"href":"/guides/metadata/templates/index"},{"title":"List all metadata templates","description":null,"href":"/guides/metadata/templates/list"},{"title":"Get a metadata template","description":null,"href":"/guides/metadata/templates/get"},{"title":"Create a metadata template","description":null,"href":"/guides/metadata/templates/create"},{"title":"Update a metadata template","description":null,"href":"/guides/metadata/templates/update"},{"title":"Delete a metadata template","description":null,"href":"/guides/metadata/templates/delete"}]},{"group":"Metadata taxonomies","pages":[{"title":"Metadata taxonomies overview","sidebarTitle":"Overview","description":null,"href":"/guides/metadata/taxonomies/index"},{"title":"Create metadata taxonomy items","description":null,"href":"/guides/metadata/taxonomies/create"},{"title":"List metadata taxonomies","description":null,"href":"/guides/metadata/taxonomies/list"},{"title":"Get metadata taxonomy items","description":null,"href":"/guides/metadata/taxonomies/get"},{"title":"Update metadata taxonomies","description":null,"href":"/guides/metadata/taxonomies/update"},{"title":"Remove metadata taxonomy items","description":null,"href":"/guides/metadata/taxonomies/remove"}]},{"group":"Metadata fields","pages":[{"title":"Metadata fields","sidebarTitle":"Overview","description":null,"href":"/guides/metadata/fields/index"},{"title":"String metadata field","description":null,"href":"/guides/metadata/fields/string"},{"title":"Float metadata field","description":null,"href":"/guides/metadata/fields/float"},{"title":"Date metadata field","description":null,"href":"/guides/metadata/fields/date"},{"title":"Enum metadata field","description":null,"href":"/guides/metadata/fields/enum"},{"title":"Multi Select metadata field","description":null,"href":"/guides/metadata/fields/multi-select"}]},{"group":"Metadata instances","pages":[{"title":"Metadata instances overview","sidebarTitle":"Overview","description":null,"href":"/guides/metadata/instances/index"},{"title":"List all metadata on an item","description":null,"href":"/guides/metadata/instances/list"},{"title":"Get metadata on item","description":null,"href":"/guides/metadata/instances/get"},{"title":"Apply metadata to an item","description":null,"href":"/guides/metadata/instances/create"},{"title":"Update metadata on an item","description":null,"href":"/guides/metadata/instances/update"},{"title":"Remove metadata from an item","description":null,"href":"/guides/metadata/instances/delete"}]},{"group":"Metadata queries","pages":[{"title":"Metadata queries","sidebarTitle":"Overview","description":null,"href":"/guides/metadata/queries/index"},{"title":"Create a query","description":null,"href":"/guides/metadata/queries/create"},{"title":"Query syntax","description":null,"href":"/guides/metadata/queries/syntax"},{"title":"Query item fields","description":null,"href":"/guides/metadata/queries/item-fields"},{"title":"Common errors","description":null,"href":"/guides/metadata/queries/errors"},{"title":"Metadata query limitations","sidebarTitle":"Limitations","description":null,"href":"/guides/metadata/queries/limitations"},{"title":"Paginate and sort","description":null,"href":"/guides/metadata/queries/pagination"},{"title":"Comparison to regular search","description":null,"href":"/guides/metadata/queries/comparison"}]},{"group":"Metadata cascade policies","pages":[{"title":"Metadata cascade policies overview","sidebarTitle":"Overview","description":null,"href":"/guides/metadata/cascades/index"},{"title":"List metadata cascade policies","description":null,"href":"/guides/metadata/cascades/list"},{"title":"Get a metadata cascade policy","description":null,"href":"/guides/metadata/cascades/get"},{"title":"Create a metadata cascade policy","description":null,"href":"/guides/metadata/cascades/create"},{"title":"Force-apply metadata to all items in a folder","description":null,"href":"/guides/metadata/cascades/force-apply"},{"title":"Delete a metadata cascade policy","description":null,"href":"/guides/metadata/cascades/delete"}]}]},{"group":"Query","pages":[{"title":"Box query","description":null,"href":"/guides/query/box-query"},{"title":"Query insights","description":null,"href":"/guides/query/insights"}]},{"group":"Search","pages":[{"title":"Search","sidebarTitle":"Overview","description":null,"href":"/guides/search/index"},{"group":"Search content using metadata","pages":[{"title":"Search content using metadata","type":"quick-start","hide_step_number":true,"hide_in_page_nav":true,"sidebarTitle":"Overview","description":null,"href":"/guides/search/quick-start/index"},{"title":"Create a Metadata Template","sidebarTitle":"1. Create a Metadata Template","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/search/quick-start/create-metadata-template"},{"title":"Locate Information about a Metadata Template","sidebarTitle":"2. Locate Information about a Metadata Template","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/search/quick-start/locate-template-info"},{"title":"Add Metadata Template to a File","sidebarTitle":"3. Add Metadata Template to a File","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/search/quick-start/apply-template-to-file"},{"title":"Use the Metadata Query API","sidebarTitle":"4. Use the Metadata Query API","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/search/quick-start/metadata-query-api"},{"title":"Next Steps","sidebarTitle":"5. Next Steps","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/search/quick-start/next-steps"}]},{"title":"Search indexing","description":null,"href":"/guides/search/indexing"},{"title":"Query operators","description":null,"href":"/guides/search/query-operators"},{"title":"Filter search results","description":null,"href":"/guides/search/filtering"},{"title":"Search result pagination","sidebarTitle":"Pagination","description":null,"href":"/guides/search/pagination"},{"title":"Metadata Query Filters","description":null,"href":"/guides/search/metadata-filters"},{"title":"Enterprise-wide search","description":null,"href":"/guides/search/enterprise"},{"title":"Searching trash","description":null,"href":"/guides/search/trash"},{"title":"Finding recent shared links","description":null,"href":"/guides/search/shared-links"},{"title":"Requesting extra fields","description":null,"href":"/guides/search/fields"}]}]},{"group":"Events \u0026 webhooks","pages":[{"group":"Events","pages":[{"title":"Events overview","sidebarTitle":"Overview","description":"Subscribe to user or enterprise events in Box, compare stream types, and monitor actions in real time or query historical records.","href":"/guides/events/index"},{"group":"User Events","pages":[{"title":"User Events","sidebarTitle":"Overview","description":null,"href":"/guides/events/user-events/index"},{"title":"Get User Events","description":null,"href":"/guides/events/user-events/for-user"},{"title":"Long-Poll Events","description":null,"href":"/guides/events/user-events/polling"}]},{"group":"Enterprise Events","pages":[{"title":"Enterprise Events","sidebarTitle":"Overview","description":null,"href":"/guides/events/enterprise-events/index"},{"title":"Get Enterprise Events","description":null,"href":"/guides/events/enterprise-events/for-enterprise"},{"title":"Migrating From History To Stream","description":null,"href":"/guides/events/enterprise-events/migrate-to-stream"}]},{"group":"Event Stream Parameters","pages":[{"title":"Stream Types","description":null,"href":"/guides/events/parameters/stream-types"},{"title":"Stream Position Pagination","description":null,"href":"/guides/events/parameters/pagination"}]},{"group":"Event Triggers","pages":[{"title":"Event Triggers","sidebarTitle":"Overview","description":null,"href":"/guides/events/event-triggers/index"},{"title":"Event Source","description":null,"href":"/guides/events/event-triggers/event-source"},{"title":"AI Security Detection Events","description":null,"href":"/guides/events/event-triggers/ai-security-detection-events"},{"title":"Shield Alert Events","description":null,"href":"/guides/events/event-triggers/shield-alert-events"},{"title":"Shield Information Barrier Events","description":null,"href":"/guides/events/event-triggers/shield-information-barrier-events"},{"title":"Shield Smart Access Events","description":null,"href":"/guides/events/event-triggers/shield-smart-access-events"},{"title":"Sign Events","description":null,"href":"/guides/events/event-triggers/sign-events"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks overview","sidebarTitle":"Overview","description":"Monitor Box content for events and get notified at a URL of your choice, and compare V1 and V2 webhooks.","href":"/guides/webhooks/index"},{"title":"Webhook Event Triggers","description":null,"href":"/guides/webhooks/triggers"},{"group":"V1 Webhooks","pages":[{"title":"V1 Webhooks","description":null,"href":"/guides/webhooks/v1/index"},{"title":"Create webhooks (v1)","sidebarTitle":"Create webhooks","description":null,"href":"/guides/webhooks/v1/create-v1"},{"title":"Delete webhooks (v1)","sidebarTitle":"Delete webhooks","description":null,"href":"/guides/webhooks/v1/delete-v1"}]},{"group":"V2 Webhooks","pages":[{"title":"V2 webhooks","description":"Understand the payload headers, JSON body, and delivery retry behavior of Box V2 webhooks.","href":"/guides/webhooks/v2/index"},{"title":"List Webhooks for a User","description":null,"href":"/guides/webhooks/v2/list-v2"},{"title":"Create webhooks (v2)","sidebarTitle":"Create webhooks","description":null,"href":"/guides/webhooks/v2/create-v2"},{"title":"Update Webhooks","description":null,"href":"/guides/webhooks/v2/update-v2"},{"title":"Delete webhooks (v2)","sidebarTitle":"Delete webhooks","description":null,"href":"/guides/webhooks/v2/delete-v2"},{"title":"Verify Box webhook signatures","description":"Verify Box webhook payloads with HMAC signatures so you can reject requests that were not sent by Box.","href":"/guides/webhooks/v2/signatures-v2"},{"title":"Webhook limitations","sidebarTitle":"Limitations","description":null,"href":"/guides/webhooks/v2/limitations-v2"}]}]}]},{"group":"Users","pages":[{"title":"Users overview","related_pages":null,"sidebarTitle":"Overview","description":null,"href":"/guides/users/index"},{"title":"Create Managed User","related_pages":[],"description":null,"href":"/guides/users/create-managed-user"},{"title":"Create App User","related_pages":[],"description":null,"href":"/guides/users/create-app-user"},{"title":"Delete User","related_pages":[],"description":null,"href":"/guides/users/delete-user"},{"title":"Bulk delete external users","related_pages":[],"description":null,"href":"/guides/users/bulk-delete-external-users"},{"group":"Provision Users","pages":[{"title":"Provision Users","sidebarTitle":"Overview","description":null,"href":"/guides/users/provision/index"},{"title":"Create Architecture Skeleton","related_pages":[],"description":null,"href":"/guides/users/provision/architecture"},{"title":"Populate Content","related_pages":[],"description":null,"href":"/guides/users/provision/populate-content"},{"title":"Setup Shared Folders","related_pages":[],"description":null,"href":"/guides/users/provision/shared-folders"}]},{"group":"Deprovision Users","pages":[{"title":"Deprovision Users","related_pages":null,"sidebarTitle":"Overview","description":null,"href":"/guides/users/deprovision/index"},{"title":"Transfer Files \u0026 Folders","related_pages":[],"description":null,"href":"/guides/users/deprovision/transfer-folders"}]}]},{"group":"Intelligent workflow","pages":[{"title":"Intelligent workflow","description":"Build governed, agentic content workflows without running your own automation infrastructure.","sidebarTitle":"Overview","href":"/guides/intelligent-workflow/index"},{"group":"Box Automate","pages":[{"title":"Box Automate","sidebarTitle":"Overview","description":null,"href":"/guides/box-automate/index"},{"title":"Get started with Box Automate","sidebarTitle":"Get started","description":null,"href":"/guides/box-automate/getting-started-box-automate"},{"title":"Triggers, outcomes, and logic in Box Automate","sidebarTitle":"Triggers and logic","description":null,"href":"/guides/box-automate/triggers-and-logic"}]},{"group":"Box Doc Gen","pages":[{"title":"Box Doc Gen","sidebarTitle":"Overview","description":null,"href":"/guides/docgen/index"},{"title":"Get started with Box Doc Gen","description":null,"href":"/guides/docgen/docgen-getting-started"},{"title":"Mark file as Box Doc Gen template","description":null,"href":"/guides/docgen/mark-template"},{"title":"Generate documents","description":null,"href":"/guides/docgen/generate-document"},{"title":"Box Doc Gen templates","description":null,"href":"/guides/docgen/docgen-templates"},{"title":"Box Doc Gen jobs","description":null,"href":"/guides/docgen/docgen-jobs"},{"title":"Box Doc Split","description":"Use the Box API to break a multi-page PDF stored in Box into smaller sub-documents and save the results to a Box folder.","href":"/guides/docgen/doc-split"},{"title":"Manual split","description":"Divide a PDF stored in Box into sub-documents using the exact page ranges you define.","href":"/guides/docgen/manual-split"},{"title":"Smart split","description":"Use a natural language prompt to let Box decide how to group the pages of a PDF into output documents.","href":"/guides/docgen/smart-split"}]},{"group":"Box Relay","pages":[{"title":"Box Relay","sidebarTitle":"Overview","description":null,"href":"/guides/box-relay/index"},{"title":"Get Workflows","description":null,"href":"/guides/box-relay/get-workflows"},{"title":"Start Workflow","description":null,"href":"/guides/box-relay/start-workflow"}]}]},{"group":"E-signatures","pages":[{"title":"Box Sign","sidebarTitle":"Overview","description":"Send documents for electronic signature from your own app using the Box Sign API, and track them through to a signed file in Box.","href":"/guides/box-sign/index"},{"title":"Set up Box Sign","sidebarTitle":"Setup","description":"Check your account type, enable the required scopes, and set up a safe place to test before you call the Box Sign API.","href":"/guides/box-sign/setup"},{"centered":true,"title":"Quick start","sidebarTitle":"Quick start","description":"Send your first Box Sign request with a file, destination folder, and signer email.","href":"/guides/box-sign/quick-start"},{"group":"Document types","pages":[{"centered":true,"sidebarTitle":"Overview","title":"Document types","description":"Choose how to send a Box Sign request for unstructured documents, templates, or structured tagged files.","href":"/guides/box-sign/document-types/index"},{"centered":true,"title":"Signing unstructured docs","sidebarTitle":"Unstructured","description":"Prepare an unstructured document in Box Sign before you send it to a signer.","href":"/guides/box-sign/document-types/unstructured"},{"centered":true,"title":"Signing structured docs","sidebarTitle":"Structured","description":"Send a Box Sign request for a document that already includes signature tags.","href":"/guides/box-sign/document-types/structured"},{"title":"Create a sign request with a template","sidebarTitle":"Templates","description":"Create a Box Sign template in the web app, list it through the API, and send a request with template_id and prefill tags.","href":"/guides/box-sign/document-types/sign-templates"}]},{"group":"Create and configure","pages":[{"title":"Create a Box Sign request","sidebarTitle":"Create a request","description":"Create a Box Sign request with files, signers, templates, and document preparation.","href":"/guides/box-sign/create-sign-request"},{"title":"Multiple signers and signing order","sidebarTitle":"Multiple signers","description":"Assign signer, approver, and final copy reader roles, and control the order in which Box Sign notifies each person.","href":"/guides/box-sign/multiple-signers"},{"title":"Verify signer identity","sidebarTitle":"Signer verification","description":"Require a signer to verify their identity with a smart card, SMS, or Box login, and add a password to a Box Sign request.","href":"/guides/box-sign/signer-verification"},{"title":"In-person signing","sidebarTitle":"In-person signing","description":"Let a signer complete a Box Sign request on the requester's device, and cycle through several in-person signers in one session.","href":"/guides/box-sign/in-person-signing"},{"title":"21 CFR Part 11 requests","sidebarTitle":"21 CFR Part 11","description":"Send GxP signature requests through the Box Sign API with request_flow set to cfr11, and handle the extra validation rules.","href":"/guides/box-sign/cfr-part-11"},{"title":"Deliver the request to signers","sidebarTitle":"Deliver to signers","description":"Customize Box Sign email, send your own notifications, or embed the signing client so signers can complete a request in your app.","href":"/guides/box-sign/how-signers-get-the-request"}]},{"group":"Manage requests","pages":[{"title":"List and get Box Sign requests","sidebarTitle":"List and get requests","description":"List all Box Sign requests for the current user, or get a single request by ID.","href":"/guides/box-sign/list-sign-requests"},{"title":"Resend a Box Sign request","sidebarTitle":"Resend a request","description":"Resend a Box Sign request email to remaining signers, or enable automatic reminders when you create the request.","href":"/guides/box-sign/resend-sign-request"},{"title":"Cancel a Box Sign request","sidebarTitle":"Cancel a request","description":"Cancel an unsigned Box Sign request and optionally provide a cancellation reason.","href":"/guides/box-sign/cancel-sign-request"},{"title":"Box Sign webhooks","sidebarTitle":"Webhooks","description":"Listen for Box Sign request events on a folder, create a webhook, and handle the notification payload.","href":"/guides/box-sign/webhooks"}]},{"group":"Reference","pages":[{"title":"Box Sign endpoints","sidebarTitle":"Endpoints","description":"A map of the Box Sign request and template endpoints, and what each one does.","href":"/guides/box-sign/api-endpoints"},{"title":"Box Sign request status","sidebarTitle":"Request status","description":"What each Box Sign request status means, and which statuses let you resend or cancel a request.","href":"/guides/box-sign/request-status"}]}]},{"group":"Security \u0026 compliance","pages":[{"group":"Security","pages":[{"title":"Security","sidebarTitle":"Overview","description":null,"href":"/guides/security/index"},{"title":"FedRAMP","description":null,"href":"/guides/security/fedramp"},{"title":"Device Pinners","description":null,"href":"/guides/security/device-pinners"},{"title":"Cross-Origin Resource Sharing (CORS)","description":null,"href":"/guides/security/cors"},{"group":"Terms of Service","pages":[{"title":"Terms of Service","sidebarTitle":"Overview","description":null,"href":"/guides/security/terms-of-service/index"},{"title":"Application Flow","description":null,"href":"/guides/security/terms-of-service/flow"},{"title":"Find Terms for Collaboration","description":null,"href":"/guides/security/terms-of-service/for-colaboration"},{"title":"Permissions","description":null,"href":"/guides/security/terms-of-service/permissions"}]}]},{"group":"Legal Holds","pages":[{"title":"Legal Holds","sidebarTitle":"Overview","description":null,"href":"/guides/legal-holds/index"},{"title":"List All Legal Hold Policies","description":null,"href":"/guides/legal-holds/list"},{"title":"Get Legal Hold Policy","description":null,"href":"/guides/legal-holds/get"}]},{"group":"Retention Policies","pages":[{"title":"Retention Policies","sidebarTitle":"Overview","description":null,"href":"/guides/retention-policies/index"},{"title":"List All Retention Policies","description":null,"href":"/guides/retention-policies/list"},{"title":"Get Retention Policy","description":null,"href":"/guides/retention-policies/get"}]}]}]},{"tab":"AI","pages":[{"group":"AI","pages":[{"title":"Build with AI","timestamp":false,"description":null,"href":"/ai"},{"group":"Supported AI models","pages":[{"title":"Supported AI models","description":"Core and customer-enabled AI models available in Box AI, with access levels, capability tiers, and API names.","sidebarTitle":"Overview","href":"/guides/box-ai/ai-models/index"},{"title":"OpenAI GPT-6.1 Sol","description":"Model card for OpenAI GPT-6.1 Sol, including API name, context window, and Box AI override details.","href":"/guides/box-ai/ai-models/openai-gpt-6-1-sol-model-card"},{"title":"OpenAI GPT-6 Sol","description":"Model card for OpenAI GPT-6 Sol, including API name, context window, and Box AI override details.","href":"/guides/box-ai/ai-models/openai-gpt-6-sol-model-card"},{"title":"OpenAI GPT-6 Luna","description":"Model card for OpenAI GPT-6 Luna, including API name, context window, and Box AI override details.","href":"/guides/box-ai/ai-models/openai-gpt-6-luna-model-card"},{"title":"OpenAI GPT-6 Astra","description":"Model card for OpenAI GPT-6 Astra, including API name, context window, and Box AI override details.","href":"/guides/box-ai/ai-models/openai-gpt-6-astra-model-card"},{"title":"OpenAI GPT-5.6 Sol","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-6-sol-model-card"},{"title":"OpenAI GPT-5.6 Terra","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-6-terra-model-card"},{"title":"OpenAI GPT-5.6 Luna","description":"Model card for OpenAI GPT-5.6 Luna, including API name, context window, and Box AI override details.","href":"/guides/box-ai/ai-models/openai-gpt-5-6-luna-model-card"},{"title":"OpenAI GPT-5.5","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-5-model-card"},{"title":"OpenAI GPT-5.4","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-4-model-card"},{"title":"OpenAI GPT-5.4 mini","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-4-mini-model-card"},{"title":"OpenAI GPT-5.2","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-2-model-card"},{"title":"OpenAI GPT-5.1","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-1-model-card"},{"title":"OpenAI GPT-5","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-model-card"},{"title":"OpenAI GPT-5 mini","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-5-mini-model-card"},{"title":"OpenAI GPT o3","description":null,"href":"/guides/box-ai/ai-models/openai-gpt-o3-model-card"},{"title":"Azure text-embedding-ada-002","description":null,"href":"/guides/box-ai/ai-models/azure-text-embedding-ada-002-model-card"},{"title":"Google Gemini 3.8 Flash","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-8-flash-model-card"},{"title":"Google Gemini 3.7 Flash","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-7-flash-model-card"},{"title":"Google Gemini 3.6 Flash","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-6-flash-model-card"},{"title":"Google Gemini 3.5 Flash","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-5-flash-model-card"},{"title":"Google Gemini 3.5 Flash Lite","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-5-flash-lite-model-card"},{"title":"Google Gemini 3.1 Pro","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-1-pro-model-card"},{"title":"Google Gemini 3.1 Flash Lite","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-1-flash-lite-model-card"},{"title":"Google Gemini 3 Flash","description":null,"href":"/guides/box-ai/ai-models/google-gemini-3-flash-model-card"},{"title":"Google Gemini 2.5 Pro","description":null,"href":"/guides/box-ai/ai-models/google-gemini-2-5-pro-model-card"},{"title":"Google Gemini 2.5 Flash","description":null,"href":"/guides/box-ai/ai-models/google-gemini-2-5-flash-model-card"},{"title":"AWS Claude Haiku 5.5","description":"Model card for AWS Claude Haiku 5.5, including API name, context window, and Box AI override details.","href":"/guides/box-ai/ai-models/aws-claude-haiku-5-5-model-card"},{"title":"AWS Claude Sonnet 5.5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-sonnet-5-5-model-card"},{"title":"AWS Claude Opus 5.5","description":"Model details for AWS Claude Opus 5.5, a premium Anthropic model hosted on Amazon Web Services and available in Box AI.","href":"/guides/box-ai/ai-models/aws-claude-opus-5-5-model-card"},{"title":"AWS Claude Fable 5.1","description":null,"href":"/guides/box-ai/ai-models/aws-claude-fable-5-1-model-card"},{"title":"AWS Claude Fable 5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-fable-5-model-card"},{"title":"AWS Claude Opus 5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-opus-5-model-card"},{"title":"AWS Claude Sonnet 5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-sonnet-5-model-card"},{"title":"AWS Claude Opus 4.8","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-8-opus-model-card"},{"title":"AWS Claude Opus 4.7","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-7-opus-model-card"},{"title":"AWS Claude Opus 4.6","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-6-opus-model-card"},{"title":"AWS Claude Sonnet 4.6","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-6-sonnet-model-card"},{"title":"AWS Claude Opus 4.5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-5-opus-model-card"},{"title":"AWS Claude Sonnet 4.5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-5-sonnet-model-card"},{"title":"AWS Claude Haiku 4.5","description":null,"href":"/guides/box-ai/ai-models/aws-claude-4-5-haiku-model-card"},{"title":"IBM Llama 4 Maverick","description":null,"href":"/guides/box-ai/ai-models/ibm-llama-4-maverick-model-card"},{"title":"Meta Muse Spark 1.3","description":null,"href":"/guides/box-ai/ai-models/meta-muse-spark-1-3-model-card"},{"title":"Meta Muse Spark 1.2","description":null,"href":"/guides/box-ai/ai-models/meta-muse-spark-1-2-model-card"},{"title":"IBM Mistral Medium 3","description":null,"href":"/guides/box-ai/ai-models/ibm-mistral-medium-3-model-card"},{"title":"IBM Mistral Small 3.1","description":null,"href":"/guides/box-ai/ai-models/ibm-mistral-small-3-1-model-card"}]},{"group":"AI integrations","pages":[{"title":"Build RAG over enterprise documents stored in Box","sidebarTitle":"RAG on Box content","description":"Build retrieval-augmented generation (RAG) over documents in Box. Start with Box Hubs and Box AI Ask for permission-aware answers. Export to Pinecone or Weaviate, or use LangChain, when you need a custom retrieval stack.","href":"/ai/rag"},{"title":"AI integrations","description":"Connect Box to LangChain, LlamaIndex, Pinecone, Weaviate, and other AI frameworks. Use Box Hubs and Box AI Ask for permission-aware RAG.","href":"/ai/integrations"},{"title":"Box and Pinecone","description":"Build a RAG pipeline by connecting Box content to Pinecone for vector search and question answering.","href":"/ai/vector-databases/pinecone"},{"title":"Box and Weaviate","description":"Build an end-to-end RAG workflow by embedding Box content into Weaviate and querying it with the Weaviate Query Agent.","href":"/ai/vector-databases/weaviate"}]},{"title":"Box Agent Skills","description":null,"href":"/ai/agent-skills"},{"title":"Box AI API agent configurator","description":"Configure Box AI API agents with a visual configurator. Choose from multiple AI models from leading providers, all accessible through a single, easy-to-use platform. Fine-tune Box AI API and LLM parameters, then export a ready-to-use JSON configuration for your Box AI API requests.","mode":"wide","href":"/agent-configurator"},{"group":"Box AI","pages":[{"title":"Box AI","description":"Ask questions, extract metadata, and summarize files stored in Box with the Box AI API. Covers request handling, input limits, and agent overrides.","sidebarTitle":"About Box AI","href":"/guides/box-ai/index"},{"title":"Get started with Box AI","description":"Create a platform app, enable the AI scope, and generate a developer token to start using the Box AI API.","href":"/guides/box-ai/ai-tutorials/prerequisites"},{"title":"Ask questions to Box AI","description":"Use the POST /ai/ask endpoint to ask questions about one or more files stored in Box.","href":"/guides/box-ai/ai-tutorials/ask-questions"},{"title":"Generate text with Box AI","description":"Use the POST /ai/text_gen endpoint to generate or refine text based on file content stored in Box.","href":"/guides/box-ai/ai-tutorials/generate-text"},{"title":"Extract APIs overview and use cases","description":"Explore Box AI Extract use cases including structured and freeform metadata extraction, and how to run extraction jobs across many documents in parallel with one file per request.","href":"/guides/box-ai/ai-tutorials/extract-use-cases"},{"title":"Extract metadata from file (freeform)","description":"Use the POST /ai/extract endpoint to extract metadata from documents using natural language prompts.","href":"/guides/box-ai/ai-tutorials/extract-metadata"},{"title":"Extract metadata from file (structured)","description":"Use the POST /ai/extract_structured endpoint to extract metadata using templates, field definitions, or the Enhanced Extract Agent.","href":"/guides/box-ai/ai-tutorials/extract-metadata-structured"},{"group":"AI model overrides","pages":[{"title":"AI model overrides","description":"Override the default AI model, prompt, and LLM parameters used by Box AI API endpoints.","sidebarTitle":"Overview","href":"/guides/box-ai/ai-agents/index"},{"title":"Get default AI agent configuration","description":"Fetch the current default agent configuration for ask, text_gen, extract, and extract_structured modes.","href":"/guides/box-ai/ai-agents/get-agent-default-config"},{"title":"AI agent configuration versioning","description":"See how Box versions AI agent snapshots, the 12-month support guarantee, and transition timelines.","href":"/guides/box-ai/ai-agents/ai-agent-versioning"},{"title":"AI model configuration override reference","description":"Full ai_agent parameter reference with sample configurations and parameter details.","href":"/guides/box-ai/ai-agents/ai-agent-overrides"},{"title":"Override AI model configuration","description":"Step-by-step examples of overriding prompts and models for ask, text_gen, and extract endpoints.","href":"/guides/box-ai/ai-tutorials/default-agent-overrides"}]},{"group":"AI quick starts","pages":[{"title":"Extract structured data with Box AI in Python","sidebarTitle":"Extracting structured data","description":"Learn how to use Box AI to automatically extract structured data from documents and store it as searchable metadata using the Box Python SDK.","href":"/guides/box-ai/quick-start/box-ai-extract"},{"title":"Natural language extraction with Box AI in Python","sidebarTitle":"Extracting freeform data","description":"Learn how to use Box AI to automatically extract data from documents with natural language prompts using the Box Python SDK.","href":"/guides/box-ai/quick-start/box-ai-extract-freeform"},{"title":"Structured extraction with the Box AI Enhanced Extract Agent in Python","sidebarTitle":"Extracting complex data","description":"Learn how to use the Box AI Enhanced Extract Agent to automatically extract data from large, complex documents using the Box Python SDK.","href":"/guides/box-ai/quick-start/box-ai-extract-enhanced"},{"title":"Summarize files with Box AI in Python","sidebarTitle":"Summarizing data","description":"Learn how to use Box AI to automatically extract structured data from documents and store it as searchable metadata using the Box Python SDK.","href":"/guides/box-ai/quick-start/box-ai-summarize"}]},{"title":"Box AI API","description":"Ask questions, extract metadata, generate text, and summarize files in Box with the Box AI API.","href":"/ai/box-ai-api"},{"group":"Box AI Studio","pages":[{"title":"Box AI Studio","description":"Create, manage, and deploy custom AI agents through the Box AI Studio API.","sidebarTitle":"Overview","href":"/guides/ai-studio/index"},{"title":"Get started with AI Studio","description":"Set up a platform app and authenticate to start creating custom AI agents with the Box AI Studio API.","href":"/guides/ai-studio/getting-started-ai-studio"},{"group":"AI Studio Agents","pages":[{"title":"AI Studio agents","description":"Create, list, update, and delete custom AI agents through the Box AI Studio API.","sidebarTitle":"Overview","href":"/guides/ai-studio/ai-studio-agents/index"},{"title":"Create agents","description":"Create a custom AI agent using the Box AI Studio API.","href":"/guides/ai-studio/ai-studio-agents/create-agents"},{"title":"List agents","description":"List all AI agents in your enterprise using the Box AI Studio API.","href":"/guides/ai-studio/ai-studio-agents/get-agents"},{"title":"Get AI agent by ID","description":"Retrieve a specific AI agent's configuration using the Box AI Studio API.","href":"/guides/ai-studio/ai-studio-agents/get-agent-id"},{"title":"Update AI agents","description":"Update a custom AI agent's configuration using the Box AI Studio API.","href":"/guides/ai-studio/ai-studio-agents/update-agents"},{"title":"Delete AI agents","description":"Permanently delete a custom AI agent using the Box AI Studio API.","href":"/guides/ai-studio/ai-studio-agents/delete-agents"}]}]}]},{"group":"Box MCP server","pages":[{"title":"Box MCP server","sidebarTitle":"Box MCP server","description":"Hosted Model Context Protocol (MCP) server at https://mcp.box.com that lets AI agents search and use Box files over OAuth.","href":"/guides/box-mcp/index"},{"title":"Give an AI agent secure, permission-aware access to enterprise documents","sidebarTitle":"Permission-aware agent access","description":"Give an AI agent secure access to enterprise documents in Box. The Box MCP server and Box APIs act as the authenticated user or application. Scopes, collaborations, and waterfall permissions still apply.","href":"/guides/box-mcp/permission-aware-access"},{"group":"Configuration","pages":[{"title":"Set up the MCP server","sidebarTitle":"Set up the MCP server","description":null,"href":"/guides/box-mcp/setup"},{"group":"Platform setup guides","pages":[{"title":"Anthropic's Messages API","sidebarTitle":"Anthropic Messages API","description":null,"href":"/guides/box-mcp/integrations/anthropic-messages-api"},{"title":"Box MCP for Claude Code","sidebarTitle":"Claude Code","description":"Connect the Box MCP server to Claude Code so your coding agent can search and use Box content from the terminal.","href":"/guides/box-mcp/integrations/claude-code"},{"title":"Codex","sidebarTitle":"Codex","description":null,"href":"/guides/box-mcp/integrations/codex"},{"title":"Cursor","sidebarTitle":"Cursor","description":null,"href":"/guides/box-mcp/integrations/cursor"},{"title":"Box MCP for GitHub Copilot","sidebarTitle":"GitHub Copilot","description":"Connect the Box MCP server to GitHub Copilot in VS Code so Copilot can search and use files in Box.","href":"/guides/box-mcp/integrations/github-copilot"},{"title":"Groq Responses API","sidebarTitle":"Groq Responses API","description":null,"href":"/guides/box-mcp/integrations/groq-responses-api"},{"title":"LangSmith Agent Builder","sidebarTitle":"LangSmith Agent Builder","description":null,"href":"/guides/box-mcp/integrations/langsmith-agent-builder"},{"title":"Microsoft Foundry Tools","sidebarTitle":"Microsoft Foundry Tools","description":"Connect the Box MCP server to Microsoft Foundry Tools. The agent acts as the authorizing Box user. Scopes and Box file permissions still apply.","href":"/guides/box-mcp/integrations/microsoft-foundry-tools"},{"title":"OpenAI AgentKit","sidebarTitle":"OpenAI AgentKit","description":null,"href":"/guides/box-mcp/integrations/openai-agentkit"},{"title":"Windows ODR (On Device Registry)","sidebarTitle":"Windows ODR (On Device Registry)","description":null,"href":"/guides/box-mcp/integrations/windows-on-device-registry"}]}]},{"title":"Available tools","sidebarTitle":"Available tools","description":"Reference list of Box MCP server tools by category, including which tools an admin must turn on before agents can use them.","href":"/guides/box-mcp/tools"},{"group":"Appendix","pages":[{"title":"Self-hosted Box MCP server (legacy)","sidebarTitle":"Self-hosted Box MCP server (legacy)","description":"Deprecated open-source MCP server for local use. Prefer the remote Box MCP server for new integrations.","href":"/guides/box-mcp/self-hosted/index"}]}]},{"title":"Box Mount","sidebarTitle":"Box Mount","description":"Mount a Box folder into an agent runtime as a POSIX filesystem, kept in two-way sync, with Box permissions and governance applied to every operation.","tag":"Preview","href":"/guides/box-mount"}]}]},{"tab":"API reference","groups":[{"group":"API reference","pages":[{"title":"API Reference","sidebarTitle":"Overview","timestamp":false,"description":null,"href":"/reference"},{"group":"AI","root":{"title":"AI resources","description":null,"href":"/reference/ai-resources"},"pages":[{"title":"Get AI agent default configuration","openapi":"box-openapi.json GET /ai_agent_default","description":"Get the AI agent default config.","href":"/reference/get-ai-agent-default"},{"title":"Ask question","openapi":"box-openapi.json POST /ai/ask","description":"Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.\n\nYou can ask a question about a single file, several files, or the entire contents of a Box Hub. To search across and ask questions about everything in a Box Hub, send a single item with `type` set to `hubs` and the Hub's ID as the `id`. Box AI answers the question using the indexed content of all files in that Hub.\n\nAsking questions about a Box Hub requires Box AI for Hubs to be enabled in the Admin Console before the Hub is created, so that its content is indexed.","href":"/reference/post-ai-ask"},{"title":"Extract metadata (freeform)","openapi":"box-openapi.json POST /ai/extract","description":"Sends an AI request to supported Large Language Models (LLMs) and extracts metadata in form of key-value pairs. In this request, both the prompt and the output can be freeform. Metadata template setup before sending the request is not required.","href":"/reference/post-ai-extract"},{"title":"Extract metadata (structured)","openapi":"box-openapi.json POST /ai/extract_structured","description":"Sends an AI request to supported Large Language Models (LLMs) and returns extracted metadata as a set of key-value pairs.\n\nTo define the extraction structure, provide either a metadata template or a list of fields. To learn more about creating templates, see [Creating metadata templates in the Admin Console](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates) or use the [metadata template API](/guides/metadata/templates/create).\n\nThis endpoint also supports [Enhanced Extract Agent](/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent).\n\nFor information about supported file formats and languages, see the [Extract metadata from file (structured)](/guides/box-ai/ai-tutorials/extract-metadata-structured) API guide.","href":"/reference/post-ai-extract-structured"},{"title":"Generate text","openapi":"box-openapi.json POST /ai/text_gen","description":"Sends an AI request to supported Large Language Models (LLMs) and returns generated text based on the provided prompt.","href":"/reference/post-ai-text-gen"}]},{"group":"AI Studio","root":{"title":"AI Studio resources","description":null,"href":"/reference/ai-studio-resources"},"pages":[{"title":"Get AI agent by agent ID","openapi":"box-openapi.json GET /ai_agents/{agent_id}","description":"Gets an AI Agent using the `agent_id` parameter.","href":"/reference/get-ai-agents-id"},{"title":"List AI agents","openapi":"box-openapi.json GET /ai_agents","description":"Lists AI agents based on the provided parameters.","href":"/reference/get-ai-agents"},{"title":"Create AI agent","openapi":"box-openapi.json POST /ai_agents","description":"Creates an AI agent. At least one of the following capabilities must be provided: `ask`, `text_gen`, `extract`.","href":"/reference/post-ai-agents"},{"title":"Update AI agent","openapi":"box-openapi.json PUT /ai_agents/{agent_id}","description":"Updates an AI agent.","href":"/reference/put-ai-agents-id"},{"title":"Delete AI agent","openapi":"box-openapi.json DELETE /ai_agents/{agent_id}","description":"Deletes an AI agent using the provided parameters.","href":"/reference/delete-ai-agents-id"}]},{"group":"App item associations","root":{"title":"App item associations resources","description":null,"href":"/reference/app-item-associations-resources"},"pages":[{"title":"List file app item associations","openapi":"box-openapi.json GET /files/{file_id}/app_item_associations","description":"**This is a beta feature, which means that its availability might be limited.** Returns all app items the file is associated with. This includes app items associated with ancestors of the file. Assuming the context user has access to the file, the type/ids are revealed even if the context user does not have **View** permission on the app item.","href":"/reference/get-files-id-app-item-associations"},{"title":"List folder app item associations","openapi":"box-openapi.json GET /folders/{folder_id}/app_item_associations","description":"**This is a beta feature, which means that its availability might be limited.** Returns all app items the folder is associated with. This includes app items associated with ancestors of the folder. Assuming the context user has access to the folder, the type/ids are revealed even if the context user does not have **View** permission on the app item.","href":"/reference/get-folders-id-app-item-associations"}]},{"group":"Authorization","root":{"title":"Authorization resources","description":null,"href":"/reference/authorization-resources"},"pages":[{"title":"Authorize user","openapi":"box-openapi.json GET /authorize","description":"Authorize a user by sending them through the [Box](https://box.com) website and request their permission to act on their behalf.\n\nThis is the first step when authenticating a user using OAuth 2.0. To request a user's authorization to use the Box APIs on their behalf you will need to send a user to the URL with this format.","href":"/reference/get-authorize"},{"title":"Refresh access token","openapi":"box-openapi.json POST /oauth2/token#refresh","description":"Refresh an Access Token using its client ID, secret, and refresh token.","href":"/reference/post-oauth2-token--refresh"},{"title":"Request access token","openapi":"box-openapi.json POST /oauth2/token","description":"Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion.\n\nAn Access Token is a string that enables Box to verify that a request belongs to an authorized session. In the normal order of operations you will begin by requesting authentication from the [authorize](/reference/get-authorize) endpoint and Box will send you an authorization code.\n\nYou will then send this code to this endpoint to exchange it for an Access Token. The returned Access Token can then be used to to make Box API calls.","href":"/reference/post-oauth2-token"},{"title":"Revoke access token","openapi":"box-openapi.json POST /oauth2/revoke","description":"Revoke an active Access Token, effectively logging a user out that has been previously authenticated.","href":"/reference/post-oauth2-revoke"}]},{"group":"Box Sign requests","root":{"title":"Box Sign requests resources","description":null,"href":"/reference/sign-requests-resources"},"pages":[{"title":"Get Box Sign request by ID","openapi":"box-openapi.json GET /sign_requests/{sign_request_id}","description":"Gets a sign request by ID.","href":"/reference/get-sign-requests-id"},{"title":"List Box Sign requests","openapi":"box-openapi.json GET /sign_requests","description":"Gets signature requests created by a user. If the `sign_files` and/or `parent_folder` are deleted, the signature request will not return in the list.","href":"/reference/get-sign-requests"},{"title":"Cancel Box Sign request","openapi":"box-openapi.json POST /sign_requests/{sign_request_id}/cancel","description":"Cancels a sign request.","href":"/reference/post-sign-requests-id-cancel"},{"title":"Create Box Sign request","openapi":"box-openapi.json POST /sign_requests","description":"Creates a signature request. This involves preparing a document for signing and sending the signature request to signers.","href":"/reference/post-sign-requests"},{"title":"Resend Box Sign request","openapi":"box-openapi.json POST /sign_requests/{sign_request_id}/resend","description":"Resends a signature request email to all outstanding signers.","href":"/reference/post-sign-requests-id-resend"}]},{"group":"Box Sign templates","root":{"title":"Box Sign templates resources","description":null,"href":"/reference/sign-templates-resources"},"pages":[{"title":"Get Box Sign template by ID","openapi":"box-openapi.json GET /sign_templates/{template_id}","description":"Fetches details of a specific Box Sign template.","href":"/reference/get-sign-templates-id"},{"title":"List Box Sign templates","openapi":"box-openapi.json GET /sign_templates","description":"Gets Box Sign templates created by a user.","href":"/reference/get-sign-templates"}]},{"group":"Classifications","root":{"title":"Classifications resources","description":null,"href":"/reference/classifications-resources"},"pages":[{"title":"List all classifications","openapi":"box-openapi.json GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"Retrieves the classification metadata template and lists all the classifications available to this enterprise.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.","href":"/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema"},{"title":"Add initial classifications","openapi":"box-openapi.json POST /metadata_templates/schema#classifications","description":"When an enterprise does not yet have any classifications, this API call initializes the classification template with an initial set of classifications.\n\nIf an enterprise already has a classification, the template will already exist and instead an API call should be made to add additional classifications.","href":"/reference/post-metadata-templates-schema--classifications"},{"title":"Add classification","openapi":"box-openapi.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add","description":"Adds one or more new classifications to the list of classifications available to the enterprise.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.","href":"/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add"},{"title":"Update classification","openapi":"box-openapi.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update","description":"Updates the labels and descriptions of one or more classifications available to the enterprise.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`.","href":"/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update"}]},{"group":"Classifications on files","pages":[{"title":"Get classification on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Retrieves the classification metadata instance that has been applied to a file.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.","href":"/reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Add classification to file","openapi":"box-openapi.json POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Adds a classification to a file by specifying the label of the classification to add.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.","href":"/reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Update classification on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Updates a classification on a file.\n\nThe classification can only be updated if a classification has already been applied to the file before. When editing classifications, only values are defined for the enterprise will be accepted.","href":"/reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Remove classification from file","openapi":"box-openapi.json DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Removes any classifications from a file.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`.","href":"/reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"Classifications on folders","pages":[{"title":"Get classification on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Retrieves the classification metadata instance that has been applied to a folder.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.","href":"/reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Add classification to folder","openapi":"box-openapi.json POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Adds a classification to a folder by specifying the label of the classification to add.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.","href":"/reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Update classification on folder","openapi":"box-openapi.json PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Updates a classification on a folder.\n\nThe classification can only be updated if a classification has already been applied to the folder before. When editing classifications, only values are defined for the enterprise will be accepted.","href":"/reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"Remove classification from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"Removes any classifications from a folder.\n\nThis API can also be called by including the enterprise ID in the URL explicitly, for example `/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`.","href":"/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"Collaborations","root":{"title":"Collaborations resources","description":null,"href":"/reference/user-collaborations-resources"},"pages":[{"title":"Get collaboration","openapi":"box-openapi.json GET /collaborations/{collaboration_id}","description":"Retrieves a single collaboration.","href":"/reference/get-collaborations-id"},{"title":"Create collaboration","openapi":"box-openapi.json POST /collaborations","description":"Adds a collaboration for a single user or a single group to a file or folder.\n\nCollaborations can be created using email address, user IDs, or a group IDs.\n\nIf a collaboration is being created with a group, access to this endpoint is dependent on the group's ability to be invited.\n\nIf collaboration is in `pending` status, field `name` is redacted when:\n\n- a collaboration was created using `user_id`,\n- a collaboration was created using `login`.","href":"/reference/post-collaborations"},{"title":"Update collaboration","openapi":"box-openapi.json PUT /collaborations/{collaboration_id}","description":"Updates a collaboration. Can be used to change the owner of an item, or to accept collaboration invites. In case of accepting collaboration invite, role is not required.","href":"/reference/put-collaborations-id"},{"title":"Remove collaboration","openapi":"box-openapi.json DELETE /collaborations/{collaboration_id}","description":"Deletes a single collaboration.","href":"/reference/delete-collaborations-id"}]},{"group":"Collaborations (List)","pages":[{"title":"List file collaborations","openapi":"box-openapi.json GET /files/{file_id}/collaborations","description":"Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.","href":"/reference/get-files-id-collaborations"},{"title":"List folder collaborations","openapi":"box-openapi.json GET /folders/{folder_id}/collaborations","description":"Retrieves a list of pending and active collaborations for a folder. This returns all the users that have access to the folder or have been invited to the folder.","href":"/reference/get-folders-id-collaborations"},{"title":"List group collaborations","openapi":"box-openapi.json GET /groups/{group_id}/collaborations","description":"Retrieves all the collaborations for a group. The user must have admin permissions to inspect enterprise's groups.\n\nEach collaboration object has details on which files or folders the group has access to and with what role.","href":"/reference/get-groups-id-collaborations"},{"title":"List pending collaborations","openapi":"box-openapi.json GET /collaborations","description":"Retrieves all pending collaboration invites for this user.","href":"/reference/get-collaborations"}]},{"group":"Collections","root":{"title":"Collections resources","description":null,"href":"/reference/collections-resources"},"pages":[{"title":"Get collection by ID","openapi":"box-openapi.json GET /collections/{collection_id}","description":"Retrieves a collection by its ID.","href":"/reference/get-collections-id"},{"title":"List all collections","openapi":"box-openapi.json GET /collections","description":"Retrieves all collections for a given user.\n\nCurrently, only the `favorites` collection is supported.","href":"/reference/get-collections"},{"title":"List collection items","openapi":"box-openapi.json GET /collections/{collection_id}/items","description":"Retrieves the files and/or folders contained within this collection.","href":"/reference/get-collections-id-items"}]},{"group":"Comments","root":{"title":"Comments resources","description":null,"href":"/reference/comments-resources"},"pages":[{"title":"Get comment","openapi":"box-openapi.json GET /comments/{comment_id}","description":"Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.","href":"/reference/get-comments-id"},{"title":"List file comments","openapi":"box-openapi.json GET /files/{file_id}/comments","description":"Retrieves a list of comments for a file.","href":"/reference/get-files-id-comments"},{"title":"Create comment","openapi":"box-openapi.json POST /comments","description":"Adds a comment by the user to a specific file, or as a reply to an other comment.","href":"/reference/post-comments"},{"title":"Update comment","openapi":"box-openapi.json PUT /comments/{comment_id}","description":"Update the message of a comment.","href":"/reference/put-comments-id"},{"title":"Remove comment","openapi":"box-openapi.json DELETE /comments/{comment_id}","description":"Permanently deletes a comment.","href":"/reference/delete-comments-id"}]},{"group":"Device pinners","root":{"title":"Device pinners resources","description":null,"href":"/reference/device-pinners-resources"},"pages":[{"title":"Get device pin","openapi":"box-openapi.json GET /device_pinners/{device_pinner_id}","description":"Retrieves information about an individual device pin.","href":"/reference/get-device-pinners-id"},{"title":"List enterprise device pins","openapi":"box-openapi.json GET /enterprises/{enterprise_id}/device_pinners","description":"Retrieves all the device pins within an enterprise.\n\nThe user must have admin privileges, and the application needs the \"manage enterprise\" scope to make this call.","href":"/reference/get-enterprises-id-device-pinners"},{"title":"Remove device pin","openapi":"box-openapi.json DELETE /device_pinners/{device_pinner_id}","description":"Deletes an individual device pin.","href":"/reference/delete-device-pinners-id"}]},{"group":"Domain restrictions (User exemptions)","root":{"title":"Domain restrictions (User exemptions) resources","description":null,"href":"/reference/collaboration-allowlist-exempt-targets-resources"},"pages":[{"title":"Get user exempt from collaboration domain restrictions","openapi":"box-openapi.json GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","description":"Returns a users who has been exempt from the collaboration domain restrictions.","href":"/reference/get-collaboration-whitelist-exempt-targets-id"},{"title":"List users exempt from collaboration domain restrictions","openapi":"box-openapi.json GET /collaboration_whitelist_exempt_targets","description":"Returns a list of users who have been exempt from the collaboration domain restrictions.","href":"/reference/get-collaboration-whitelist-exempt-targets"},{"title":"Create user exemption from collaboration domain restrictions","openapi":"box-openapi.json POST /collaboration_whitelist_exempt_targets","description":"Exempts a user from the restrictions set out by the allowed list of domains for collaborations.","href":"/reference/post-collaboration-whitelist-exempt-targets"},{"title":"Remove user from list of users exempt from domain restrictions","openapi":"box-openapi.json DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","description":"Removes a user's exemption from the restrictions set out by the allowed list of domains for collaborations.","href":"/reference/delete-collaboration-whitelist-exempt-targets-id"}]},{"group":"Domain restrictions for collaborations","root":{"title":"Domain restrictions for collaborations resources","description":null,"href":"/reference/collaboration-allowlist-entries-resources"},"pages":[{"title":"Get allowed collaboration domain","openapi":"box-openapi.json GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","description":"Returns a domain that has been deemed safe to create collaborations for within the current enterprise.","href":"/reference/get-collaboration-whitelist-entries-id"},{"title":"List allowed collaboration domains","openapi":"box-openapi.json GET /collaboration_whitelist_entries","description":"Returns the list domains that have been deemed safe to create collaborations for within the current enterprise.","href":"/reference/get-collaboration-whitelist-entries"},{"title":"Add domain to list of allowed collaboration domains","openapi":"box-openapi.json POST /collaboration_whitelist_entries","description":"Creates a new entry in the list of allowed domains to allow collaboration for.","href":"/reference/post-collaboration-whitelist-entries"},{"title":"Remove domain from list of allowed collaboration domains","openapi":"box-openapi.json DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","description":"Removes a domain from the list of domains that have been deemed safe to create collaborations for within the current enterprise.","href":"/reference/delete-collaboration-whitelist-entries-id"}]},{"group":"Downloads","pages":[{"title":"Download file","openapi":"box-openapi.json GET /files/{file_id}/content","description":"Returns the contents of a file in binary format.","href":"/reference/get-files-id-content"}]},{"group":"Email aliases","root":{"title":"Email aliases resources","description":null,"href":"/reference/email-aliases-resources"},"pages":[{"title":"List user's email aliases","openapi":"box-openapi.json GET /users/{user_id}/email_aliases","description":"Retrieves all email aliases for a user. The collection does not include the primary login for the user.","href":"/reference/get-users-id-email-aliases"},{"title":"Create email alias","openapi":"box-openapi.json POST /users/{user_id}/email_aliases","description":"Adds a new email alias to a user account..","href":"/reference/post-users-id-email-aliases"},{"title":"Remove email alias","openapi":"box-openapi.json DELETE /users/{user_id}/email_aliases/{email_alias_id}","description":"Removes an email alias from a user.","href":"/reference/delete-users-id-email-aliases-id"}]},{"group":"Events","root":{"title":"Events resources","description":null,"href":"/reference/events-resources"},"pages":[{"title":"List user and enterprise events","openapi":"box-openapi.json GET /events","description":"Returns up to a year of past events for a given user or for the entire enterprise.\n\nBy default this returns events for the authenticated user. To retrieve events for the entire enterprise, set the `stream_type` to `admin_logs_streaming` for live monitoring of new events, or `admin_logs` for querying across historical events. The user making the API call will need to have admin privileges, and the application will need to have the scope `manage enterprise properties` checked.","href":"/reference/get-events"},{"title":"Get events long poll endpoint","openapi":"/box-openapi.json OPTIONS /events","description":null,"href":"/reference/options-events"}]},{"group":"File requests","root":{"title":"File requests resources","description":null,"href":"/reference/file-requests-resources"},"pages":[{"title":"Get file request","openapi":"box-openapi.json GET /file_requests/{file_request_id}","description":"Retrieves the information about a file request.","href":"/reference/get-file-requests-id"},{"title":"Copy file request","openapi":"box-openapi.json POST /file_requests/{file_request_id}/copy","description":"Copies an existing file request that is already present on one folder, and applies it to another folder.","href":"/reference/post-file-requests-id-copy"},{"title":"Update file request","openapi":"box-openapi.json PUT /file_requests/{file_request_id}","description":"Updates a file request. This can be used to activate or deactivate a file request.","href":"/reference/put-file-requests-id"},{"title":"Delete file request","openapi":"box-openapi.json DELETE /file_requests/{file_request_id}","description":"Deletes a file request permanently.","href":"/reference/delete-file-requests-id"}]},{"group":"File version legal holds","root":{"title":"File version legal holds resources","description":null,"href":"/reference/file-version-legal-holds-resources"},"pages":[{"title":"Get file version legal hold","openapi":"box-openapi.json GET /file_version_legal_holds/{file_version_legal_hold_id}","description":"Retrieves information about the legal hold policies assigned to a file version.","href":"/reference/get-file-version-legal-holds-id"},{"title":"List file version legal holds","openapi":"box-openapi.json GET /file_version_legal_holds","description":"Get a list of file versions on legal hold for a legal hold assignment.\n\nDue to ongoing re-architecture efforts this API might not return all file versions for this policy ID.\n\nInstead, this API will only return file versions held in the legacy architecture. Two new endpoints will available to request any file versions held in the new architecture.\n\nFor file versions held in the new architecture, the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to return all past file versions available for this policy assignment, and the `GET /legal_hold_policy_assignments/:id/files_on_hold` API can be used to return any current (latest) versions of a file under legal hold.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.\n\nOnce the re-architecture is completed this API will be deprecated.","href":"/reference/get-file-version-legal-holds"}]},{"group":"File version retentions","root":{"title":"File version retentions resources","description":null,"href":"/reference/file-version-retentions-resources"},"pages":[{"title":"Get retention on file","openapi":"box-openapi.json GET /file_version_retentions/{file_version_retention_id}","description":"Returns information about a file version retention.\n\n**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.","href":"/reference/get-file-version-retentions-id"},{"title":"List file version retentions","openapi":"box-openapi.json GET /file_version_retentions","description":"Retrieves all file version retentions for the given enterprise.\n\n**Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](/reference/get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](/reference/get-retention-policy-assignments-id-file-versions-under-retention) endpoints.","href":"/reference/get-file-version-retentions"}]},{"group":"File versions","root":{"title":"File versions resources","description":null,"href":"/reference/file-versions-resources"},"pages":[{"title":"Get file version","openapi":"box-openapi.json GET /files/{file_id}/versions/{file_version_id}","description":"Retrieve a specific version of a file.\n\nVersions are only tracked for Box users with premium accounts.","href":"/reference/get-files-id-versions-id"},{"title":"List all file versions","openapi":"box-openapi.json GET /files/{file_id}/versions","description":"Retrieve a list of the past versions for a file.\n\nVersions are only tracked by Box users with premium accounts. To fetch the ID of the current version of a file, use the `GET /file/:id` API.","href":"/reference/get-files-id-versions"},{"title":"Promote file version","openapi":"box-openapi.json POST /files/{file_id}/versions/current","description":"Promote a specific version of a file.\n\nIf previous versions exist, this method can be used to promote one of the older versions to the top of the version history.\n\nThis creates a new copy of the old version and puts it at the top of the versions history. The file will have the exact same contents as the older version, with the same hash digest, `etag`, and name as the original.\n\nOther properties such as comments do not get updated to their former values.\n\nDon't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.","href":"/reference/post-files-id-versions-current"},{"title":"Restore file version","openapi":"box-openapi.json PUT /files/{file_id}/versions/{file_version_id}","description":"Restores a specific version of a file after it was deleted. Don't use this endpoint to restore Box Notes, as it works with file formats such as PDF, DOC, PPTX or similar.","href":"/reference/put-files-id-versions-id"},{"title":"Remove file version","openapi":"box-openapi.json DELETE /files/{file_id}/versions/{file_version_id}","description":"Move a file version to the trash.\n\nVersions are only tracked for Box users with premium accounts.","href":"/reference/delete-files-id-versions-id"}]},{"group":"Files","root":{"title":"Files resources","description":null,"href":"/reference/files-resources"},"pages":[{"title":"Get file information","openapi":"box-openapi.json GET /files/{file_id}","description":"Retrieves the details about a file.","href":"/reference/get-files-id"},{"title":"Get file thumbnail","openapi":"box-openapi.json GET /files/{file_id}/thumbnail.{extension}","description":"Retrieves a thumbnail, or smaller image representation, of a file.\n\nSizes of `32x32`,`64x64`, `128x128`, and `256x256` can be returned in the `.png` format and sizes of `32x32`, `160x160`, and `320x320` can be returned in the `.jpg` format.\n\nThumbnails can be generated for the image and video file formats listed [found on our community site][1].\n\n[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327","href":"/reference/get-files-id-thumbnail-id"},{"title":"Copy file","openapi":"box-openapi.json POST /files/{file_id}/copy","description":"Creates a copy of a file.","href":"/reference/post-files-id-copy"},{"title":"Update file","openapi":"box-openapi.json PUT /files/{file_id}","description":"Updates a file. This can be used to rename or move a file, create a shared link, or lock a file.","href":"/reference/put-files-id"},{"title":"Delete file","openapi":"box-openapi.json DELETE /files/{file_id}","description":"Deletes a file, either permanently or by moving it to the trash.\n\nThe enterprise settings determine whether the item will be permanently deleted from Box or moved to the trash.","href":"/reference/delete-files-id"}]},{"group":"Folder Locks","root":{"title":"Folder Locks resources","description":null,"href":"/reference/folder-locks-resources"},"pages":[{"title":"List folder locks","openapi":"box-openapi.json GET /folder_locks","description":"Retrieves folder lock details for a given folder.\n\nYou must be authenticated as the owner or co-owner of the folder to use this endpoint.","href":"/reference/get-folder-locks"},{"title":"Create folder lock","openapi":"box-openapi.json POST /folder_locks","description":"Creates a folder lock on a folder, preventing it from being moved and/or deleted.\n\nYou must be authenticated as the owner or co-owner of the folder to use this endpoint.","href":"/reference/post-folder-locks"},{"title":"Delete folder lock","openapi":"box-openapi.json DELETE /folder_locks/{folder_lock_id}","description":"Deletes a folder lock on a given folder.\n\nYou must be authenticated as the owner or co-owner of the folder to use this endpoint.","href":"/reference/delete-folder-locks-id"}]},{"group":"Folders","root":{"title":"Folders resources","description":null,"href":"/reference/folders-resources"},"pages":[{"title":"Get folder information","openapi":"box-openapi.json GET /folders/{folder_id}","description":"Retrieves details for a folder, including the first 100 entries in the folder.\n\nPassing `sort`, `direction`, `offset`, and `limit` parameters in query allows you to manage the list of returned [folder items](/reference/resources/folder--full#param-item-collection).\n\nTo fetch more items within the folder, use the [Get items in a folder](/reference/get-folders-id-items) endpoint.","href":"/reference/get-folders-id"},{"title":"List items in folder","openapi":"box-openapi.json GET /folders/{folder_id}/items","description":"Retrieves a page of items in a folder. These items can be files, folders, and web links.\n\nTo request more information about the folder itself, like its size, use the [Get a folder](/reference/get-folders-id) endpoint instead.","href":"/reference/get-folders-id-items"},{"title":"Copy folder","openapi":"box-openapi.json POST /folders/{folder_id}/copy","description":"Creates a copy of a folder within a destination folder.\n\nThe original folder will not be changed.","href":"/reference/post-folders-id-copy"},{"title":"Create folder","openapi":"box-openapi.json POST /folders","description":"Creates a new empty folder within the specified parent folder.","href":"/reference/post-folders"},{"title":"Update folder","openapi":"box-openapi.json PUT /folders/{folder_id}","description":"Updates a folder. This can be also be used to move the folder, create shared links, update collaborations, and more.","href":"/reference/put-folders-id"},{"title":"Delete folder","openapi":"box-openapi.json DELETE /folders/{folder_id}","description":"Deletes a folder, either permanently or by moving it to the trash.","href":"/reference/delete-folders-id"}]},{"group":"Group memberships","root":{"title":"Group memberships resources","description":null,"href":"/reference/memberships-resources"},"pages":[{"title":"Get group membership","openapi":"box-openapi.json GET /group_memberships/{group_membership_id}","description":"Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.","href":"/reference/get-group-memberships-id"},{"title":"List members of group","openapi":"box-openapi.json GET /groups/{group_id}/memberships","description":"Retrieves all the members for a group. Only members of this group or users with admin-level permissions will be able to use this API.","href":"/reference/get-groups-id-memberships"},{"title":"List user's groups","openapi":"box-openapi.json GET /users/{user_id}/memberships","description":"Retrieves all the groups for a user. Only members of this group or users with admin-level permissions will be able to use this API.","href":"/reference/get-users-id-memberships"},{"title":"Add user to group","openapi":"box-openapi.json POST /group_memberships","description":"Creates a group membership. Only users with admin-level permissions will be able to use this API.","href":"/reference/post-group-memberships"},{"title":"Update group membership","openapi":"box-openapi.json PUT /group_memberships/{group_membership_id}","description":"Updates a user's group membership. Only admins of this group or users with admin-level permissions will be able to use this API.","href":"/reference/put-group-memberships-id"},{"title":"Remove user from group","openapi":"box-openapi.json DELETE /group_memberships/{group_membership_id}","description":"Deletes a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.","href":"/reference/delete-group-memberships-id"}]},{"group":"Groups","root":{"title":"Groups resources","description":null,"href":"/reference/groups-resources"},"pages":[{"title":"Get group","openapi":"box-openapi.json GET /groups/{group_id}","description":"Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.","href":"/reference/get-groups-id"},{"title":"List groups for enterprise","openapi":"box-openapi.json GET /groups","description":"Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.","href":"/reference/get-groups"},{"title":"Create group","openapi":"box-openapi.json POST /groups","description":"Creates a new group of users in an enterprise. Only users with admin permissions can create new groups.","href":"/reference/post-groups"},{"title":"Update group","openapi":"box-openapi.json PUT /groups/{group_id}","description":"Updates a specific group. Only admins of this group or users with admin-level permissions will be able to use this API.","href":"/reference/put-groups-id"},{"title":"Remove group","openapi":"box-openapi.json DELETE /groups/{group_id}","description":"Permanently deletes a group. Only users with admin-level permissions will be able to use this API.","href":"/reference/delete-groups-id"}]},{"group":"Integration mappings","root":{"title":"Integration mappings resources","description":null,"href":"/reference/integration-mappings-resources"},"pages":[{"title":"List Slack integration mappings","openapi":"box-openapi.json GET /integration_mappings/slack","description":"Lists [Slack integration mappings](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) in a users' enterprise.\n\nYou need Admin or Co-Admin role to use this endpoint.","href":"/reference/get-integration-mappings-slack"},{"title":"List Teams integration mappings","openapi":"box-openapi.json GET /integration_mappings/teams","description":"Lists [Teams integration mappings](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) in a users' enterprise. You need Admin or Co-Admin role to use this endpoint.","href":"/reference/get-integration-mappings-teams"},{"title":"Create Slack integration mapping","openapi":"box-openapi.json POST /integration_mappings/slack","description":"Creates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack) by mapping a Slack channel to a Box item.\n\nYou need Admin or Co-Admin role to use this endpoint.","href":"/reference/post-integration-mappings-slack"},{"title":"Create Teams integration mapping","openapi":"box-openapi.json POST /integration_mappings/teams","description":"Creates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams) by mapping a Teams channel to a Box item. You need Admin or Co-Admin role to use this endpoint.","href":"/reference/post-integration-mappings-teams"},{"title":"Update Slack integration mapping","openapi":"box-openapi.json PUT /integration_mappings/slack/{integration_mapping_id}","description":"Updates a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack). Supports updating the Box folder ID and options.\n\nYou need Admin or Co-Admin role to use this endpoint.","href":"/reference/put-integration-mappings-slack-id"},{"title":"Update Teams integration mapping","openapi":"box-openapi.json PUT /integration_mappings/teams/{integration_mapping_id}","description":"Updates a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams). Supports updating the Box folder ID and options. You need Admin or Co-Admin role to use this endpoint.","href":"/reference/put-integration-mappings-teams-id"},{"title":"Delete Slack integration mapping","openapi":"box-openapi.json DELETE /integration_mappings/slack/{integration_mapping_id}","description":"Deletes a [Slack integration mapping](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack).\n\nYou need Admin or Co-Admin role to use this endpoint.","href":"/reference/delete-integration-mappings-slack-id"},{"title":"Delete Teams integration mapping","openapi":"box-openapi.json DELETE /integration_mappings/teams/{integration_mapping_id}","description":"Deletes a [Teams integration mapping](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams). You need Admin or Co-Admin role to use this endpoint.","href":"/reference/delete-integration-mappings-teams-id"}]},{"group":"Invites","root":{"title":"Invites resources","description":null,"href":"/reference/invites-resources"},"pages":[{"title":"Get user invite status","openapi":"box-openapi.json GET /invites/{invite_id}","description":"Returns the status of a user invite.","href":"/reference/get-invites-id"},{"title":"Create user invite","openapi":"box-openapi.json POST /invites","description":"Invites an existing external user to join an enterprise.\n\nThe existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.\n\nThis method requires the \"Manage An Enterprise\" scope enabled for the application, which can be enabled within the developer console.","href":"/reference/post-invites"}]},{"group":"Legal hold policies","root":{"title":"Legal hold policies resources","description":null,"href":"/reference/legal-hold-policies-resources"},"pages":[{"title":"Get legal hold policy","openapi":"box-openapi.json GET /legal_hold_policies/{legal_hold_policy_id}","description":"Retrieve a legal hold policy.","href":"/reference/get-legal-hold-policies-id"},{"title":"List all legal hold policies","openapi":"box-openapi.json GET /legal_hold_policies","description":"Retrieves a list of legal hold policies that belong to an enterprise.","href":"/reference/get-legal-hold-policies"},{"title":"Create legal hold policy","openapi":"box-openapi.json POST /legal_hold_policies","description":"Create a new legal hold policy.","href":"/reference/post-legal-hold-policies"},{"title":"Update legal hold policy","openapi":"box-openapi.json PUT /legal_hold_policies/{legal_hold_policy_id}","description":"Update legal hold policy.","href":"/reference/put-legal-hold-policies-id"},{"title":"Remove legal hold policy","openapi":"box-openapi.json DELETE /legal_hold_policies/{legal_hold_policy_id}","description":"Delete an existing legal hold policy.\n\nThis is an asynchronous process. The policy will not be fully deleted yet when the response returns.","href":"/reference/delete-legal-hold-policies-id"}]},{"group":"Legal hold policy assignments","root":{"title":"Legal hold policy assignments resources","description":null,"href":"/reference/legal-hold-policy-assignments-resources"},"pages":[{"title":"Get legal hold policy assignment","openapi":"box-openapi.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","description":"Retrieve a legal hold policy assignment.","href":"/reference/get-legal-hold-policy-assignments-id"},{"title":"List files with current file versions for legal hold policy assignment","openapi":"box-openapi.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold","description":"Get a list of files with current file versions for a legal hold assignment.\n\nIn some cases you may want to get previous file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/file_versions_on_hold` API instead to return any previous versions of a file for this legal hold policy assignment.\n\nDue to ongoing re-architecture efforts this API might not return all file versions held for this policy ID. Instead, this API will only return the latest file version held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture.\n\nThis endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.","href":"/reference/get-legal-hold-policy-assignments-id-files-on-hold"},{"title":"List legal hold policy assignments","openapi":"box-openapi.json GET /legal_hold_policy_assignments","description":"Retrieves a list of items a legal hold policy has been assigned to.","href":"/reference/get-legal-hold-policy-assignments"},{"title":"List previous file versions for legal hold policy assignment","openapi":"box-openapi.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold","description":"Get a list of previous file versions for a legal hold assignment.\n\nIn some cases you may only need the latest file versions instead. In these cases, use the `GET /legal_hold_policy_assignments/:id/files_on_hold` API instead to return any current (latest) versions of a file for this legal hold policy assignment.\n\nDue to ongoing re-architecture efforts this API might not return all files held for this policy ID. Instead, this API will only return past file versions held in the newly developed architecture. The `GET /file_version_legal_holds` API can be used to fetch current and past versions of files held within the legacy architecture.\n\nThis endpoint does not support returning any content that is on hold due to a Custodian collaborating on a Hub.\n\nThe `GET /legal_hold_policy_assignments?policy_id={id}` API can be used to find a list of policy assignments for a given policy ID.","href":"/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold"},{"title":"Assign legal hold policy","openapi":"box-openapi.json POST /legal_hold_policy_assignments","description":"Assign a legal hold to an item type of: file, file version, folder, user, ownership, or interactions.","href":"/reference/post-legal-hold-policy-assignments"},{"title":"Unassign legal hold policy","openapi":"box-openapi.json DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","description":"Remove a legal hold from an item.\n\nThis is an asynchronous process. The policy will not be fully removed yet when the response returns.","href":"/reference/delete-legal-hold-policy-assignments-id"}]},{"group":"Metadata cascade policies","root":{"title":"Metadata cascade policies resources","description":null,"href":"/reference/metadata-cascade-policies-resources"},"pages":[{"title":"Get metadata cascade policy","openapi":"box-openapi.json GET /metadata_cascade_policies/{metadata_cascade_policy_id}","description":"Retrieve a specific metadata cascade policy assigned to a folder.","href":"/reference/get-metadata-cascade-policies-id"},{"title":"List metadata cascade policies","openapi":"box-openapi.json GET /metadata_cascade_policies","description":"Retrieves a list of all the metadata cascade policies that are applied to a given folder. This can not be used on the root folder with ID `0`.","href":"/reference/get-metadata-cascade-policies"},{"title":"Create metadata cascade policy","openapi":"box-openapi.json POST /metadata_cascade_policies","description":"Creates a new metadata cascade policy that applies a given metadata template to a given folder and automatically cascades it down to any files within that folder.\n\nIn order for the policy to be applied a metadata instance must first be applied to the folder the policy is to be applied to.","href":"/reference/post-metadata-cascade-policies"},{"title":"Force-apply metadata cascade policy to folder","openapi":"box-openapi.json POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply","description":"Force the metadata on a folder with a metadata cascade policy to be applied to all of its children. This can be used after creating a new cascade policy to enforce the metadata to be cascaded down to all existing files within that folder.","href":"/reference/post-metadata-cascade-policies-id-apply"},{"title":"Remove metadata cascade policy","openapi":"box-openapi.json DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}","description":"Deletes a metadata cascade policy.","href":"/reference/delete-metadata-cascade-policies-id"}]},{"group":"Metadata instances (Files)","root":{"title":"Metadata instances (Files) resources","description":null,"href":"/reference/file-metadata-resources"},"pages":[{"title":"Get metadata instance on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/{scope}/{template_key}","description":"Retrieves the instance of a metadata template that has been applied to a file.","href":"/reference/get-files-id-metadata-id-id"},{"title":"List metadata instances on file","openapi":"box-openapi.json GET /files/{file_id}/metadata","description":"Retrieves all metadata for a given file.","href":"/reference/get-files-id-metadata"},{"title":"Create metadata instance on file","openapi":"box-openapi.json POST /files/{file_id}/metadata/{scope}/{template_key}","description":"Applies an instance of a metadata template to a file.\n\nIn most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.","href":"/reference/post-files-id-metadata-id-id"},{"title":"Update metadata instance on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/{scope}/{template_key}","description":"Updates a piece of metadata on a file.\n\nThe metadata instance can only be updated if the template has already been applied to the file before. When editing metadata, only values that match the metadata template schema will be accepted.\n\nThe update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.","href":"/reference/put-files-id-metadata-id-id"},{"title":"Remove metadata instance from file","openapi":"box-openapi.json DELETE /files/{file_id}/metadata/{scope}/{template_key}","description":"Deletes a piece of file metadata.","href":"/reference/delete-files-id-metadata-id-id"}]},{"group":"Metadata instances (Folders)","pages":[{"title":"Get metadata instance on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata/{scope}/{template_key}","description":"Retrieves the instance of a metadata template that has been applied to a folder. This can not be used on the root folder with ID `0`.","href":"/reference/get-folders-id-metadata-id-id"},{"title":"List metadata instances on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata","description":"Retrieves all metadata for a given folder. This can not be used on the root folder with ID `0`.","href":"/reference/get-folders-id-metadata"},{"title":"Create metadata instance on folder","openapi":"box-openapi.json POST /folders/{folder_id}/metadata/{scope}/{template_key}","description":"Applies an instance of a metadata template to a folder.\n\nIn most cases only values that are present in the metadata template will be accepted, except for the `global.properties` template which accepts any key-value pair.\n\nTo display the metadata template in the Box web app the enterprise needs to be configured to enable **Cascading Folder Level Metadata** for the user in the admin console.","href":"/reference/post-folders-id-metadata-id-id"},{"title":"Update metadata instance on folder","openapi":"box-openapi.json PUT /folders/{folder_id}/metadata/{scope}/{template_key}","description":"Updates a piece of metadata on a folder.\n\nThe metadata instance can only be updated if the template has already been applied to the folder before. When editing metadata, only values that match the metadata template schema will be accepted.\n\nThe update is applied atomically. If any errors occur during the application of the operations, the metadata instance will not be changed.","href":"/reference/put-folders-id-metadata-id-id"},{"title":"Remove metadata instance from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/metadata/{scope}/{template_key}","description":"Deletes a piece of folder metadata.","href":"/reference/delete-folders-id-metadata-id-id"}]},{"group":"Metadata taxonomies","root":{"title":"Metadata taxonomies resources","description":null,"href":"/reference/metadata-taxonomies-resources"},"pages":[{"title":"Get metadata taxonomies for namespace","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}","description":"Used to retrieve all metadata taxonomies in a namespace.","href":"/reference/get-metadata-taxonomies-id"},{"title":"Get metadata taxonomy by taxonomy key","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}","description":"Used to retrieve a metadata taxonomy by taxonomy key.","href":"/reference/get-metadata-taxonomies-id-id"},{"title":"Get metadata taxonomy node by ID","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","description":"Retrieves a metadata taxonomy node by its identifier.","href":"/reference/get-metadata-taxonomies-id-id-nodes-id"},{"title":"List metadata taxonomy nodes","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","description":"Used to retrieve metadata taxonomy nodes based on the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.","href":"/reference/get-metadata-taxonomies-id-id-nodes"},{"title":"List metadata template's options for taxonomy field","openapi":"box-openapi.json GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options","description":"Used to retrieve metadata taxonomy nodes which are available for the taxonomy field based on its configuration and the parameters specified. Results are sorted in lexicographic order unless a `query` parameter is passed. With a `query` parameter specified, results are sorted in order of relevance.","href":"/reference/get-metadata-templates-id-id-fields-id-options"},{"title":"Add metadata taxonomy level","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append","description":"Creates a new metadata taxonomy level and appends it to the existing levels. If there are no levels defined yet, this will create the first level.","href":"/reference/post-metadata-taxonomies-id-id-levels--append"},{"title":"Create metadata taxonomy","openapi":"box-openapi.json POST /metadata_taxonomies","description":"Creates a new metadata taxonomy that can be used in metadata templates.","href":"/reference/post-metadata-taxonomies"},{"title":"Create metadata taxonomy levels","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels","description":"Creates new metadata taxonomy levels.","href":"/reference/post-metadata-taxonomies-id-id-levels"},{"title":"Create metadata taxonomy node","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","description":"Creates a new metadata taxonomy node.","href":"/reference/post-metadata-taxonomies-id-id-nodes"},{"title":"Delete metadata taxonomy level","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim","description":"Deletes the last level of the metadata taxonomy.","href":"/reference/post-metadata-taxonomies-id-id-levels--trim"},{"title":"Update metadata taxonomy","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}","description":"Updates an existing metadata taxonomy.","href":"/reference/patch-metadata-taxonomies-id-id"},{"title":"Update metadata taxonomy level","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}","description":"Updates an existing metadata taxonomy level.","href":"/reference/patch-metadata-taxonomies-id-id-levels-id"},{"title":"Update metadata taxonomy node","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","description":"Updates an existing metadata taxonomy node.","href":"/reference/patch-metadata-taxonomies-id-id-nodes-id"},{"title":"Remove metadata taxonomy","openapi":"box-openapi.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}","description":"Delete a metadata taxonomy. This deletion is permanent and cannot be reverted.","href":"/reference/delete-metadata-taxonomies-id-id"},{"title":"Remove metadata taxonomy node","openapi":"box-openapi.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","description":"Delete a metadata taxonomy node. This deletion is permanent and cannot be reverted. Only metadata taxonomy nodes without any children can be deleted.","href":"/reference/delete-metadata-taxonomies-id-id-nodes-id"}]},{"group":"Metadata templates","root":{"title":"Metadata templates resources","description":null,"href":"/reference/metadata-templates-resources"},"pages":[{"title":"Find metadata template by instance ID","openapi":"box-openapi.json GET /metadata_templates","description":"Finds a metadata template by searching for the ID of an instance of the template.","href":"/reference/get-metadata-templates"},{"title":"Get metadata template by ID","openapi":"box-openapi.json GET /metadata_templates/{template_id}","description":"Retrieves a metadata template by its ID.","href":"/reference/get-metadata-templates-id"},{"title":"Get metadata template by name","openapi":"box-openapi.json GET /metadata_templates/{scope}/{template_key}/schema","description":"Retrieves a metadata template by its `scope` and `templateKey` values.\n\nTo find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.","href":"/reference/get-metadata-templates-id-id-schema"},{"title":"List all global metadata templates","openapi":"box-openapi.json GET /metadata_templates/global","description":"Used to retrieve all generic, global metadata templates available to all enterprises using Box.","href":"/reference/get-metadata-templates-global"},{"title":"List all metadata templates for enterprise","openapi":"box-openapi.json GET /metadata_templates/enterprise","description":"Used to retrieve all metadata templates created to be used specifically within the user's enterprise.","href":"/reference/get-metadata-templates-enterprise"},{"title":"Create metadata template","openapi":"box-openapi.json POST /metadata_templates/schema","description":"Creates a new metadata template that can be applied to files and folders.","href":"/reference/post-metadata-templates-schema"},{"title":"Update metadata template","openapi":"box-openapi.json PUT /metadata_templates/{scope}/{template_key}/schema","description":"Updates a metadata template.\n\nThe metadata template can only be updated if the template already exists.\n\nThe update is applied atomically. If any errors occur during the application of the operations, the metadata template will not be changed.","href":"/reference/put-metadata-templates-id-id-schema"},{"title":"Remove metadata template","openapi":"box-openapi.json DELETE /metadata_templates/{scope}/{template_key}/schema","description":"Delete a metadata template and its instances. This deletion is permanent and can not be reversed.","href":"/reference/delete-metadata-templates-id-id-schema"}]},{"group":"Recent items","root":{"title":"Recent items resources","description":null,"href":"/reference/recent-items-resources"},"pages":[{"title":"List recently accessed items","openapi":"box-openapi.json GET /recent_items","description":"Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.","href":"/reference/get-recent-items"}]},{"group":"Retention policies","root":{"title":"Retention policies resources","description":null,"href":"/reference/retention-policies-resources"},"pages":[{"title":"Get retention policy","openapi":"box-openapi.json GET /retention_policies/{retention_policy_id}","description":"Retrieves a retention policy.","href":"/reference/get-retention-policies-id"},{"title":"List retention policies","openapi":"box-openapi.json GET /retention_policies","description":"Retrieves all of the retention policies for an enterprise.","href":"/reference/get-retention-policies"},{"title":"Create retention policy","openapi":"box-openapi.json POST /retention_policies","description":"Creates a retention policy.","href":"/reference/post-retention-policies"},{"title":"Update retention policy","openapi":"box-openapi.json PUT /retention_policies/{retention_policy_id}","description":"Updates a retention policy.","href":"/reference/put-retention-policies-id"},{"title":"Delete retention policy","openapi":"box-openapi.json DELETE /retention_policies/{retention_policy_id}","description":"Permanently deletes a retention policy.","href":"/reference/delete-retention-policies-id"}]},{"group":"Retention policy assignments","root":{"title":"Retention policy assignments resources","description":null,"href":"/reference/retention-policy-assignments-resources"},"pages":[{"title":"Get file versions under retention","openapi":"box-openapi.json GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention","description":"Returns a list of file versions under retention for a retention policy assignment.","href":"/reference/get-retention-policy-assignments-id-file-versions-under-retention"},{"title":"Get files under retention","openapi":"box-openapi.json GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention","description":"Returns a list of files under retention for a retention policy assignment.","href":"/reference/get-retention-policy-assignments-id-files-under-retention"},{"title":"Get retention policy assignment","openapi":"box-openapi.json GET /retention_policy_assignments/{retention_policy_assignment_id}","description":"Retrieves a retention policy assignment.","href":"/reference/get-retention-policy-assignments-id"},{"title":"List retention policy assignments","openapi":"box-openapi.json GET /retention_policies/{retention_policy_id}/assignments","description":"Returns a list of all retention policy assignments associated with a specified retention policy.","href":"/reference/get-retention-policies-id-assignments"},{"title":"Assign retention policy","openapi":"box-openapi.json POST /retention_policy_assignments","description":"Assigns a retention policy to an item.","href":"/reference/post-retention-policy-assignments"},{"title":"Remove retention policy assignment","openapi":"box-openapi.json DELETE /retention_policy_assignments/{retention_policy_assignment_id}","description":"Removes a retention policy assignment applied to content.","href":"/reference/delete-retention-policy-assignments-id"}]},{"group":"Search","root":{"title":"Search resources","description":null,"href":"/reference/search-resources"},"pages":[{"title":"Search for content","openapi":"box-openapi.json GET /search","description":"Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.","href":"/reference/get-search"},{"title":"Query files/folders by metadata","openapi":"box-openapi.json POST /metadata_queries/execute_read","description":"For new integrations, use the [v2026.0 Query API](/reference/v2026.0/query-resources). This is the latest version of the Query API, with advanced capabilities including multi-template queries and Query Insights, and is the API we will continue to enhance with new Query capabilities.\n\nCreate a search using SQL-like syntax to return items that match specific metadata.\n\nBy default, this endpoint returns only the most basic info about the items for which the query matches. To get additional fields for each item, including any of the metadata, use the `fields` attribute in the query.","href":"/reference/post-metadata-queries-execute-read"}]},{"group":"Session termination","root":{"title":"Session termination resources","description":null,"href":"/reference/session-termination-resources"},"pages":[{"title":"Create jobs to terminate user group session","openapi":"box-openapi.json POST /groups/terminate_sessions","description":"Validates the roles and permissions of the group, and creates asynchronous jobs to terminate the group's sessions. Returns the status for the POST request.","href":"/reference/post-groups-terminate-sessions"},{"title":"Create jobs to terminate users session","openapi":"box-openapi.json POST /users/terminate_sessions","description":"Validates the roles and permissions of the user, and creates asynchronous jobs to terminate the user's sessions. Returns the status for the POST request.","href":"/reference/post-users-terminate-sessions"}]},{"group":"Shared links (App Items)","pages":[{"title":"Find app item for shared link","openapi":"box-openapi.json GET /shared_items#app_items","description":"Returns the app item represented by a shared link.\n\nThe link can originate from the current enterprise or another.","href":"/reference/get-shared-items--app-items"}]},{"group":"Shared links (Files)","pages":[{"title":"Find file for shared link","openapi":"box-openapi.json GET /shared_items","description":"Returns the file represented by a shared link.\n\nA shared file can be represented by a shared link, which can originate within the current enterprise or within another.\n\nThis endpoint allows an application to retrieve information about a shared file when only given a shared link.\n\nThe `shared_link_permission_options` array field can be returned by requesting it in the `fields` query parameter.","href":"/reference/get-shared-items"},{"title":"Get shared link for file","openapi":"box-openapi.json GET /files/{file_id}#get_shared_link","description":"Gets the information for a shared link on a file.","href":"/reference/get-files-id--get-shared-link"},{"title":"Add shared link to file","openapi":"box-openapi.json PUT /files/{file_id}#add_shared_link","description":"Adds a shared link to a file.","href":"/reference/put-files-id--add-shared-link"},{"title":"Remove shared link from file","openapi":"box-openapi.json PUT /files/{file_id}#remove_shared_link","description":"Removes a shared link from a file.","href":"/reference/put-files-id--remove-shared-link"},{"title":"Update shared link on file","openapi":"box-openapi.json PUT /files/{file_id}#update_shared_link","description":"Updates a shared link on a file.","href":"/reference/put-files-id--update-shared-link"}]},{"group":"Shared links (Folders)","pages":[{"title":"Find folder for shared link","openapi":"box-openapi.json GET /shared_items#folders","description":"Return the folder represented by a shared link.\n\nA shared folder can be represented by a shared link, which can originate within the current enterprise or within another.\n\nThis endpoint allows an application to retrieve information about a shared folder when only given a shared link.","href":"/reference/get-shared-items--folders"},{"title":"Get shared link for folder","openapi":"box-openapi.json GET /folders/{folder_id}#get_shared_link","description":"Gets the information for a shared link on a folder.","href":"/reference/get-folders-id--get-shared-link"},{"title":"Add shared link to folder","openapi":"box-openapi.json PUT /folders/{folder_id}#add_shared_link","description":"Adds a shared link to a folder.","href":"/reference/put-folders-id--add-shared-link"},{"title":"Remove shared link from folder","openapi":"box-openapi.json PUT /folders/{folder_id}#remove_shared_link","description":"Removes a shared link from a folder.","href":"/reference/put-folders-id--remove-shared-link"},{"title":"Update shared link on folder","openapi":"box-openapi.json PUT /folders/{folder_id}#update_shared_link","description":"Updates a shared link on a folder.","href":"/reference/put-folders-id--update-shared-link"}]},{"group":"Shared links (Web Links)","pages":[{"title":"Find web link for shared link","openapi":"box-openapi.json GET /shared_items#web_links","description":"Returns the web link represented by a shared link.\n\nA shared web link can be represented by a shared link, which can originate within the current enterprise or within another.\n\nThis endpoint allows an application to retrieve information about a shared web link when only given a shared link.","href":"/reference/get-shared-items--web-links"},{"title":"Get shared link for web link","openapi":"box-openapi.json GET /web_links/{web_link_id}#get_shared_link","description":"Gets the information for a shared link on a web link.","href":"/reference/get-web-links-id--get-shared-link"},{"title":"Add shared link to web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}#add_shared_link","description":"Adds a shared link to a web link.","href":"/reference/put-web-links-id--add-shared-link"},{"title":"Remove shared link from web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}#remove_shared_link","description":"Removes a shared link from a web link.","href":"/reference/put-web-links-id--remove-shared-link"},{"title":"Update shared link on web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}#update_shared_link","description":"Updates a shared link on a web link.","href":"/reference/put-web-links-id--update-shared-link"}]},{"group":"Shield information barrier reports","root":{"title":"Shield information barrier reports resources","description":null,"href":"/reference/shield-information-barrier-reports-resources"},"pages":[{"title":"Get shield information barrier report by ID","openapi":"box-openapi.json GET /shield_information_barrier_reports/{shield_information_barrier_report_id}","description":"Retrieves a shield information barrier report by its ID.","href":"/reference/get-shield-information-barrier-reports-id"},{"title":"List shield information barrier reports","openapi":"box-openapi.json GET /shield_information_barrier_reports","description":"Lists shield information barrier reports.","href":"/reference/get-shield-information-barrier-reports"},{"title":"Create shield information barrier report","openapi":"box-openapi.json POST /shield_information_barrier_reports","description":"Creates a shield information barrier report for a given barrier.","href":"/reference/post-shield-information-barrier-reports"}]},{"group":"Shield information barrier segment members","root":{"title":"Shield information barrier segment members resources","description":null,"href":"/reference/shield-information-barrier-segment-members-resources"},"pages":[{"title":"Get shield information barrier segment member by ID","openapi":"box-openapi.json GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","description":"Retrieves a shield information barrier segment member by its ID.","href":"/reference/get-shield-information-barrier-segment-members-id"},{"title":"List shield information barrier segment members","openapi":"box-openapi.json GET /shield_information_barrier_segment_members","description":"Lists shield information barrier segment members based on provided segment IDs.","href":"/reference/get-shield-information-barrier-segment-members"},{"title":"Create shield information barrier segment member","openapi":"box-openapi.json POST /shield_information_barrier_segment_members","description":"Creates a new shield information barrier segment member.","href":"/reference/post-shield-information-barrier-segment-members"},{"title":"Delete shield information barrier segment member by ID","openapi":"box-openapi.json DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","description":"Deletes a shield information barrier segment member based on provided ID.","href":"/reference/delete-shield-information-barrier-segment-members-id"}]},{"group":"Shield information barrier segment restrictions","root":{"title":"Shield information barrier segment restrictions resources","description":null,"href":"/reference/shield-information-barrier-segment-restrictions-resources"},"pages":[{"title":"Get shield information barrier segment restriction by ID","openapi":"box-openapi.json GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","description":"Retrieves a shield information barrier segment restriction based on provided ID.","href":"/reference/get-shield-information-barrier-segment-restrictions-id"},{"title":"List shield information barrier segment restrictions","openapi":"box-openapi.json GET /shield_information_barrier_segment_restrictions","description":"Lists shield information barrier segment restrictions based on provided segment ID.","href":"/reference/get-shield-information-barrier-segment-restrictions"},{"title":"Create shield information barrier segment restriction","openapi":"box-openapi.json POST /shield_information_barrier_segment_restrictions","description":"Creates a shield information barrier segment restriction object.","href":"/reference/post-shield-information-barrier-segment-restrictions"},{"title":"Delete shield information barrier segment restriction by ID","openapi":"box-openapi.json DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","description":"Delete shield information barrier segment restriction based on provided ID.","href":"/reference/delete-shield-information-barrier-segment-restrictions-id"}]},{"group":"Shield information barrier segments","root":{"title":"Shield information barrier segments resources","description":null,"href":"/reference/shield-information-barrier-segments-resources"},"pages":[{"title":"Get shield information barrier segment with specified ID","openapi":"box-openapi.json GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}","description":"Retrieves shield information barrier segment based on provided ID..","href":"/reference/get-shield-information-barrier-segments-id"},{"title":"List shield information barrier segments","openapi":"box-openapi.json GET /shield_information_barrier_segments","description":"Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID.","href":"/reference/get-shield-information-barrier-segments"},{"title":"Create shield information barrier segment","openapi":"box-openapi.json POST /shield_information_barrier_segments","description":"Creates a shield information barrier segment.","href":"/reference/post-shield-information-barrier-segments"},{"title":"Update shield information barrier segment with specified ID","openapi":"box-openapi.json PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}","description":"Updates the shield information barrier segment based on provided ID..","href":"/reference/put-shield-information-barrier-segments-id"},{"title":"Delete shield information barrier segment","openapi":"box-openapi.json DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}","description":"Deletes the shield information barrier segment based on provided ID.","href":"/reference/delete-shield-information-barrier-segments-id"}]},{"group":"Shield information barriers","root":{"title":"Shield information barriers resources","description":null,"href":"/reference/shield-information-barriers-resources"},"pages":[{"title":"Get shield information barrier with specified ID","openapi":"box-openapi.json GET /shield_information_barriers/{shield_information_barrier_id}","description":"Get shield information barrier based on provided ID.","href":"/reference/get-shield-information-barriers-id"},{"title":"List shield information barriers","openapi":"box-openapi.json GET /shield_information_barriers","description":"Retrieves a list of shield information barrier objects for the enterprise of JWT.","href":"/reference/get-shield-information-barriers"},{"title":"Add changed status of shield information barrier with specified ID","openapi":"box-openapi.json POST /shield_information_barriers/change_status","description":"Change status of shield information barrier with the specified ID.","href":"/reference/post-shield-information-barriers-change-status"},{"title":"Create shield information barrier","openapi":"box-openapi.json POST /shield_information_barriers","description":"Creates a shield information barrier to separate individuals/groups within the same firm and prevents confidential information passing between them.","href":"/reference/post-shield-information-barriers"}]},{"group":"Skills","root":{"title":"Skills resources","description":null,"href":"/reference/skills-resources"},"pages":[{"title":"List Box Skill cards on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/global/boxSkillsCards","description":"List the Box Skills metadata cards that are attached to a file.","href":"/reference/get-files-id-metadata-global-boxSkillsCards"},{"title":"Create Box Skill cards on file","openapi":"box-openapi.json POST /files/{file_id}/metadata/global/boxSkillsCards","description":"Applies one or more Box Skills metadata cards to a file.","href":"/reference/post-files-id-metadata-global-boxSkillsCards"},{"title":"Update all Box Skill cards on file","openapi":"box-openapi.json PUT /skill_invocations/{skill_id}","description":"An alternative method that can be used to overwrite and update all Box Skill metadata cards on a file.","href":"/reference/put-skill-invocations-id"},{"title":"Update Box Skill cards on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/global/boxSkillsCards","description":"Updates one or more Box Skills metadata cards to a file.","href":"/reference/put-files-id-metadata-global-boxSkillsCards"},{"title":"Remove Box Skill cards from file","openapi":"box-openapi.json DELETE /files/{file_id}/metadata/global/boxSkillsCards","description":"Removes any Box Skills cards metadata from a file.","href":"/reference/delete-files-id-metadata-global-boxSkillsCards"}]},{"group":"Standard and Zones Storage Policies","root":{"title":"Standard and Zones Storage Policies resources","description":null,"href":"/reference/storage-policies-resources"},"pages":[{"title":"Get storage policy","openapi":"box-openapi.json GET /storage_policies/{storage_policy_id}","description":"Fetches a specific storage policy.","href":"/reference/get-storage-policies-id"},{"title":"List storage policies","openapi":"box-openapi.json GET /storage_policies","description":"Fetches all the storage policies in the enterprise.","href":"/reference/get-storage-policies"}]},{"group":"Standard and Zones Storage Policy Assignments","root":{"title":"Standard and Zones Storage Policy Assignments resources","description":null,"href":"/reference/storage-policy-assignments-resources"},"pages":[{"title":"Get storage policy assignment","openapi":"box-openapi.json GET /storage_policy_assignments/{storage_policy_assignment_id}","description":"Fetches a specific storage policy assignment.","href":"/reference/get-storage-policy-assignments-id"},{"title":"List storage policy assignments","openapi":"box-openapi.json GET /storage_policy_assignments","description":"Fetches all the storage policy assignment for an enterprise or user.","href":"/reference/get-storage-policy-assignments"},{"title":"Assign storage policy","openapi":"box-openapi.json POST /storage_policy_assignments","description":"Creates a storage policy assignment for an enterprise or user.","href":"/reference/post-storage-policy-assignments"},{"title":"Update storage policy assignment","openapi":"box-openapi.json PUT /storage_policy_assignments/{storage_policy_assignment_id}","description":"Updates a specific storage policy assignment.","href":"/reference/put-storage-policy-assignments-id"},{"title":"Unassign storage policy","openapi":"box-openapi.json DELETE /storage_policy_assignments/{storage_policy_assignment_id}","description":"Delete a storage policy assignment.\n\nDeleting a storage policy assignment on a user will have the user inherit the enterprise's default storage policy.\n\nThere is a rate limit for calling this endpoint of only twice per user in a 24 hour time frame.","href":"/reference/delete-storage-policy-assignments-id"}]},{"group":"Task assignments","root":{"title":"Task assignments resources","description":null,"href":"/reference/task-assignments-resources"},"pages":[{"title":"Get task assignment","openapi":"box-openapi.json GET /task_assignments/{task_assignment_id}","description":"Retrieves information about a task assignment.","href":"/reference/get-task-assignments-id"},{"title":"List task assignments","openapi":"box-openapi.json GET /tasks/{task_id}/assignments","description":"Lists all of the assignments for a given task.","href":"/reference/get-tasks-id-assignments"},{"title":"Assign task","openapi":"box-openapi.json POST /task_assignments","description":"Assigns a task to a user.\n\nA task can be assigned to more than one user by creating multiple assignments.","href":"/reference/post-task-assignments"},{"title":"Update task assignment","openapi":"box-openapi.json PUT /task_assignments/{task_assignment_id}","description":"Updates a task assignment. This endpoint can be used to update the state of a task assigned to a user.","href":"/reference/put-task-assignments-id"},{"title":"Unassign task","openapi":"box-openapi.json DELETE /task_assignments/{task_assignment_id}","description":"Deletes a specific task assignment.","href":"/reference/delete-task-assignments-id"}]},{"group":"Tasks","root":{"title":"Tasks resources","description":null,"href":"/reference/tasks-resources"},"pages":[{"title":"Get task","openapi":"box-openapi.json GET /tasks/{task_id}","description":"Retrieves information about a specific task.","href":"/reference/get-tasks-id"},{"title":"List tasks on file","openapi":"box-openapi.json GET /files/{file_id}/tasks","description":"Retrieves a list of all the tasks for a file. This endpoint does not support pagination.","href":"/reference/get-files-id-tasks"},{"title":"Create task","openapi":"box-openapi.json POST /tasks","description":"Creates a single task on a file. This task is not assigned to any user and will need to be assigned separately.","href":"/reference/post-tasks"},{"title":"Update task","openapi":"box-openapi.json PUT /tasks/{task_id}","description":"Updates a task. This can be used to update a task's configuration, or to update its completion state.","href":"/reference/put-tasks-id"},{"title":"Remove task","openapi":"box-openapi.json DELETE /tasks/{task_id}","description":"Removes a task from a file.","href":"/reference/delete-tasks-id"}]},{"group":"Terms of service","root":{"title":"Terms of service resources","description":null,"href":"/reference/terms-of-services-resources"},"pages":[{"title":"Get terms of service","openapi":"box-openapi.json GET /terms_of_services/{terms_of_service_id}","description":"Fetches a specific terms of service.","href":"/reference/get-terms-of-services-id"},{"title":"List terms of services","openapi":"box-openapi.json GET /terms_of_services","description":"Returns the current terms of service text and settings for the enterprise.","href":"/reference/get-terms-of-services"},{"title":"Create terms of service","openapi":"box-openapi.json POST /terms_of_services","description":"Creates a terms of service for a given enterprise and type of user.","href":"/reference/post-terms-of-services"},{"title":"Update terms of service","openapi":"box-openapi.json PUT /terms_of_services/{terms_of_service_id}","description":"Updates a specific terms of service.","href":"/reference/put-terms-of-services-id"}]},{"group":"Terms of service user statuses","root":{"title":"Terms of service user statuses resources","description":null,"href":"/reference/terms-of-service-user-statuses-resources"},"pages":[{"title":"List terms of service user statuses","openapi":"box-openapi.json GET /terms_of_service_user_statuses","description":"Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.","href":"/reference/get-terms-of-service-user-statuses"},{"title":"Create terms of service status for new user","openapi":"box-openapi.json POST /terms_of_service_user_statuses","description":"Sets the status for a terms of service for a user.","href":"/reference/post-terms-of-service-user-statuses"},{"title":"Update terms of service status for existing user","openapi":"box-openapi.json PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}","description":"Updates the status for a terms of service for a user.","href":"/reference/put-terms-of-service-user-statuses-id"}]},{"group":"Transfer folders","pages":[{"title":"Transfer owned folders","openapi":"box-openapi.json PUT /users/{user_id}/folders/0","description":"Move all of the items (files, folders and workflows) owned by a user into another user's account.\n\nOnly the root folder (`0`) can be transferred.\n\nFolders can only be moved across users by users with administrative permissions.\n\nAll existing shared links and folder-level collaborations are transferred during the operation. Please note that while collaborations at the individual file-level are transferred during the operation, the collaborations are deleted when the original user is deleted.\n\nIf the user has a large number of items across all folders, the call will be run asynchronously. If the operation is not completed within 10 minutes, the user will receive a 200 OK response, and the operation will continue running.\n\nIf the destination path has a metadata cascade policy attached to any of the parent folders, a metadata cascade operation will be kicked off asynchronously.\n\nThere is currently no way to check for when this operation is finished.\n\nThe destination folder's name will be in the format `{User}'s Files and Folders`, where `{User}` is the display name of the user.\n\nTo make this API call your application will need to have the \"Read and write all files and folders stored in Box\" scope enabled.\n\nPlease make sure the destination user has access to `Relay` or `Relay Lite`, and has access to the files and folders involved in the workflows being transferred.\n\nAdmins will receive an email when the operation is completed.","href":"/reference/put-users-id-folders-0"}]},{"group":"Trashed files","root":{"title":"Trashed files resources","description":null,"href":"/reference/trashed-files-resources"},"pages":[{"title":"Get trashed file","openapi":"box-openapi.json GET /files/{file_id}/trash","description":"Retrieves a file that has been moved to the trash.\n\nPlease note that only if the file itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](/reference/get-folders-id-trash) API.\n\nTo list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](/reference/get-folders-trash-items/) API.","href":"/reference/get-files-id-trash"},{"title":"Restore file","openapi":"box-openapi.json POST /files/{file_id}","description":"Restores a file that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the file to in case the original folder has been deleted.","href":"/reference/post-files-id"},{"title":"Permanently remove file","openapi":"box-openapi.json DELETE /files/{file_id}/trash","description":"Permanently deletes a file that is in the trash. This action cannot be undone.","href":"/reference/delete-files-id-trash"}]},{"group":"Trashed folders","root":{"title":"Trashed folders resources","description":null,"href":"/reference/trashed-folders-resources"},"pages":[{"title":"Get trashed folder","openapi":"box-openapi.json GET /folders/{folder_id}/trash","description":"Retrieves a folder that has been moved to the trash.\n\nPlease note that only if the folder itself has been moved to the trash can it be retrieved with this API call. If instead one of its parent folders was moved to the trash, only that folder can be inspected using the [`GET /folders/:id/trash`](/reference/get-folders-id-trash) API.\n\nTo list all items that have been moved to the trash, please use the [`GET /folders/trash/items`](/reference/get-folders-trash-items/) API.","href":"/reference/get-folders-id-trash"},{"title":"Restore folder","openapi":"box-openapi.json POST /folders/{folder_id}","description":"Restores a folder that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the folder to in case the original folder has been deleted.\n\nDuring this operation, part of the file tree will be locked, mainly the source folder and all of its descendants, as well as the destination folder.\n\nFor the duration of the operation, no other move, copy, delete, or restore operation can performed on any of the locked folders.","href":"/reference/post-folders-id"},{"title":"Permanently remove folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/trash","description":"Permanently deletes a folder that is in the trash. This action cannot be undone.","href":"/reference/delete-folders-id-trash"}]},{"group":"Trashed items","pages":[{"title":"List trashed items","openapi":"box-openapi.json GET /folders/trash/items","description":"Retrieves the files and folders that have been moved to the trash.\n\nAny attribute in the full files or folders objects can be passed in with the `fields` parameter to retrieve those specific attributes that are not returned by default.\n\nThis endpoint defaults to use offset-based pagination, yet also supports marker-based pagination using the `marker` parameter.\n\nThe number of entries returned may be less than `total_count`. For example, if a user deletes items from a shared folder and is later removed as a collaborator, those deleted items will no longer appear in this endpoint’s results, even though they are still included in `total_count`.","href":"/reference/get-folders-trash-items"}]},{"group":"Trashed web links","root":{"title":"Trashed web links resources","description":null,"href":"/reference/trashed-web-links-resources"},"pages":[{"title":"Get trashed web link","openapi":"box-openapi.json GET /web_links/{web_link_id}/trash","description":"Retrieves a web link that has been moved to the trash.","href":"/reference/get-web-links-id-trash"},{"title":"Restore web link","openapi":"box-openapi.json POST /web_links/{web_link_id}","description":"Restores a web link that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the web link to in case the original folder has been deleted.","href":"/reference/post-web-links-id"},{"title":"Permanently remove web link","openapi":"box-openapi.json DELETE /web_links/{web_link_id}/trash","description":"Permanently deletes a web link that is in the trash. This action cannot be undone.","href":"/reference/delete-web-links-id-trash"}]},{"group":"Uploads","root":{"title":"Uploads resources","description":null,"href":"/reference/uploads-resources"},"pages":[{"title":"Upload file","openapi":"box-openapi.json POST /files/content","description":"Uploads a small file to Box. For file sizes over 50MB we recommend using the Chunk Upload APIs.\n\nThe `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when uploading the file will receive a HTTP `400` error with a `metadata_after_file_contents` error code.","href":"/reference/post-files-content"},{"title":"Upload file version","openapi":"box-openapi.json POST /files/{file_id}/content","description":"Update a file's content. For file sizes over 50MB we recommend using the Chunk Upload APIs.\n\nThe `attributes` part of the body must come **before** the `file` part. Requests that do not follow this format when uploading the file will receive a HTTP `400` error with a `metadata_after_file_contents` error code.","href":"/reference/post-files-id-content"},{"title":"Preflight check before upload","openapi":"/box-openapi.json OPTIONS /files/content","description":null,"href":"/reference/options-files-content"}]},{"group":"Uploads (Chunked)","root":{"title":"Uploads (Chunked) resources","description":null,"href":"/reference/chunked-uploads-resources"},"pages":[{"title":"Get upload session","openapi":"box-openapi.json GET /files/upload_sessions/{upload_session_id}","description":"Return information about an upload session.\n\nThe actual endpoint URL is returned by the [`Create upload session`](/reference/post-files-upload-sessions) endpoint.","href":"/reference/get-files-upload-sessions-id"},{"title":"List parts","openapi":"box-openapi.json GET /files/upload_sessions/{upload_session_id}/parts","description":"Return a list of the chunks uploaded to the upload session so far.\n\nThe actual endpoint URL is returned by the [`Create upload session`](/reference/post-files-upload-sessions) and [`Get upload session`](/reference/get-files-upload-sessions-id) endpoints.","href":"/reference/get-files-upload-sessions-id-parts"},{"title":"Commit upload session","openapi":"box-openapi.json POST /files/upload_sessions/{upload_session_id}/commit","description":"Close an upload session and create a file from the uploaded chunks.\n\nThe actual endpoint URL is returned by the [`Create upload session`](/reference/post-files-upload-sessions) and [`Get upload session`](/reference/get-files-upload-sessions-id) endpoints.","href":"/reference/post-files-upload-sessions-id-commit"},{"title":"Create upload session","openapi":"box-openapi.json POST /files/upload_sessions","description":"Creates an upload session for a new file.","href":"/reference/post-files-upload-sessions"},{"title":"Create upload session for existing file","openapi":"box-openapi.json POST /files/{file_id}/upload_sessions","description":"Creates an upload session for an existing file.","href":"/reference/post-files-id-upload-sessions"},{"title":"Plan upload session","openapi":"box-openapi.json POST /files/upload_sessions/{upload_session_id}/plan","description":"Plan an upload session by checking which parts already exist on the server. This endpoint allows clients to optimize uploads by skipping parts that have already been uploaded (cache hits) and only uploading missing parts.\n\nThe actual endpoint URL is returned by the [`Create upload session`](/reference/post-files-upload-sessions) and [`Get upload session`](/reference/get-files-upload-sessions-id) endpoints.","href":"/reference/post-files-upload-sessions-id-plan"},{"title":"Upload part of file","openapi":"box-openapi.json PUT /files/upload_sessions/{upload_session_id}","description":"Uploads a chunk of a file for an upload session.\n\nThe actual endpoint URL is returned by the [`Create upload session`](/reference/post-files-upload-sessions) and [`Get upload session`](/reference/get-files-upload-sessions-id) endpoints.","href":"/reference/put-files-upload-sessions-id"},{"title":"Remove upload session","openapi":"box-openapi.json DELETE /files/upload_sessions/{upload_session_id}","description":"Abort an upload session and discard all data uploaded.\n\nThis cannot be reversed.\n\nThe actual endpoint URL is returned by the [`Create upload session`](/reference/post-files-upload-sessions) and [`Get upload session`](/reference/get-files-upload-sessions-id) endpoints.","href":"/reference/delete-files-upload-sessions-id"}]},{"group":"User avatars","root":{"title":"User avatars resources","description":null,"href":"/reference/avatars-resources"},"pages":[{"title":"Get user avatar","openapi":"box-openapi.json GET /users/{user_id}/avatar","description":"Retrieves an image of a the user's avatar.","href":"/reference/get-users-id-avatar"},{"title":"Add or update user avatar","openapi":"box-openapi.json POST /users/{user_id}/avatar","description":"Adds or updates a user avatar.","href":"/reference/post-users-id-avatar"},{"title":"Delete user avatar","openapi":"box-openapi.json DELETE /users/{user_id}/avatar","description":"Removes an existing user avatar. You cannot reverse this operation.","href":"/reference/delete-users-id-avatar"}]},{"group":"Users","root":{"title":"Users resources","description":null,"href":"/reference/users-resources"},"pages":[{"title":"Get current user","openapi":"box-openapi.json GET /users/me","description":"Retrieves information about the user who is currently authenticated.\n\nIn the case of a client-side authenticated OAuth 2.0 application this will be the user who authorized the app.\n\nIn the case of a JWT, server-side authenticated application this will be the service account that belongs to the application by default.\n\nUse the `As-User` header to change who this API call is made on behalf of.","href":"/reference/get-users-me"},{"title":"Get user","openapi":"box-openapi.json GET /users/{user_id}","description":"Retrieves information about a user in the enterprise.\n\nThe application and the authenticated user need to have the permission to look up users in the entire enterprise.\n\nThis endpoint also returns a limited set of information for external users who are collaborated on content owned by the enterprise for authenticated users with the right scopes. In this case, disallowed fields will return null instead.","href":"/reference/get-users-id"},{"title":"List enterprise users","openapi":"box-openapi.json GET /users","description":"Returns a list of all users for the Enterprise along with their `user_id`, `public_name`, and `login`.\n\nThe application and the authenticated user need to have the permission to look up users in the entire enterprise.","href":"/reference/get-users"},{"title":"Create user","openapi":"box-openapi.json POST /users","description":"Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.","href":"/reference/post-users"},{"title":"Update user","openapi":"box-openapi.json PUT /users/{user_id}","description":"Updates a managed or app user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.","href":"/reference/put-users-id"},{"title":"Delete user","openapi":"box-openapi.json DELETE /users/{user_id}","description":"Deletes a user. By default, this operation fails if the user still owns any content. To proceed, move their owned content first, or use the `force` parameter to delete the user and their files.","href":"/reference/delete-users-id"}]},{"group":"Watermarks (Files)","root":{"title":"Watermarks (Files) resources","description":null,"href":"/reference/file-watermarks-resources"},"pages":[{"title":"Get watermark on file","openapi":"box-openapi.json GET /files/{file_id}/watermark","description":"Retrieve the watermark for a file.","href":"/reference/get-files-id-watermark"},{"title":"Apply watermark to file","openapi":"box-openapi.json PUT /files/{file_id}/watermark","description":"Applies or update a watermark on a file.","href":"/reference/put-files-id-watermark"},{"title":"Remove watermark from file","openapi":"box-openapi.json DELETE /files/{file_id}/watermark","description":"Removes the watermark from a file.","href":"/reference/delete-files-id-watermark"}]},{"group":"Watermarks (Folders)","pages":[{"title":"Get watermark for folder","openapi":"box-openapi.json GET /folders/{folder_id}/watermark","description":"Retrieve the watermark for a folder.","href":"/reference/get-folders-id-watermark"},{"title":"Apply watermark to folder","openapi":"box-openapi.json PUT /folders/{folder_id}/watermark","description":"Applies or update a watermark on a folder.","href":"/reference/put-folders-id-watermark"},{"title":"Remove watermark from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/watermark","description":"Removes the watermark from a folder.","href":"/reference/delete-folders-id-watermark"}]},{"group":"Web links","root":{"title":"Web links resources","description":null,"href":"/reference/web-links-resources"},"pages":[{"title":"Get web link","openapi":"box-openapi.json GET /web_links/{web_link_id}","description":"Retrieve information about a web link.","href":"/reference/get-web-links-id"},{"title":"Create web link","openapi":"box-openapi.json POST /web_links","description":"Creates a web link object within a folder.","href":"/reference/post-web-links"},{"title":"Update web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}","description":"Updates a web link object.","href":"/reference/put-web-links-id"},{"title":"Remove web link","openapi":"box-openapi.json DELETE /web_links/{web_link_id}","description":"Deletes a web link.","href":"/reference/delete-web-links-id"}]},{"group":"Webhooks","root":{"title":"Webhooks resources","description":null,"href":"/reference/webhooks-resources"},"pages":[{"title":"Get webhook","openapi":"box-openapi.json GET /webhooks/{webhook_id}","description":"Retrieves a specific webhook.","href":"/reference/get-webhooks-id"},{"title":"List all webhooks","openapi":"box-openapi.json GET /webhooks","description":"Returns all defined webhooks for the requesting application.\n\nThis API only returns webhooks that are applied to files or folders that are owned by the authenticated user. This means that an admin can not see webhooks created by a service account unless the admin has access to those folders, and vice versa.","href":"/reference/get-webhooks"},{"title":"Create webhook","openapi":"box-openapi.json POST /webhooks","description":"Creates a webhook.","href":"/reference/post-webhooks"},{"title":"Update webhook","openapi":"box-openapi.json PUT /webhooks/{webhook_id}","description":"Updates a webhook.","href":"/reference/put-webhooks-id"},{"title":"Remove webhook","openapi":"box-openapi.json DELETE /webhooks/{webhook_id}","description":"Deletes a webhook.","href":"/reference/delete-webhooks-id"}]},{"group":"Workflows","root":{"title":"Workflows resources","description":null,"href":"/reference/workflows-resources"},"pages":[{"title":"List workflows","openapi":"box-openapi.json GET /workflows","description":"Returns list of workflows that act on a given `folder ID`, and have a flow with a trigger type of `WORKFLOW_MANUAL_START`.\n\nYou application must be authorized to use the `Manage Box Relay` application scope within the developer console in to use this endpoint.","href":"/reference/get-workflows"},{"title":"Starts workflow based on request body","openapi":"box-openapi.json POST /workflows/{workflow_id}/start","description":"Initiates a flow with a trigger type of `WORKFLOW_MANUAL_START`.\n\nYou application must be authorized to use the `Manage Box Relay` application scope within the developer console.","href":"/reference/post-workflows-id-start"}]},{"group":"Zip Downloads","root":{"title":"Zip Downloads resources","description":null,"href":"/reference/zip-downloads-resources"},"pages":[{"title":"Download zip archive","openapi":"box-openapi.json GET /zip_downloads/{zip_download_id}/content","description":"Returns the contents of a `zip` archive in binary format. This URL does not require any form of authentication and could be used in a user's browser to download the archive to a user's device.\n\nBy default, this URL is only valid for a few seconds from the creation of the request for this archive. Once a download has started it can not be stopped and resumed, instead a new request for a zip archive would need to be created.\n\nThe URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `download_url` field in the response to this endpoint.","href":"/reference/get-zip-downloads-id-content"},{"title":"Get zip download status","openapi":"box-openapi.json GET /zip_downloads/{zip_download_id}/status","description":"Returns the download status of a `zip` archive, allowing an application to inspect the progress of the download as well as the number of items that might have been skipped.\n\nThis endpoint can only be accessed once the download has started. Subsequently this endpoint is valid for 12 hours from the start of the download.\n\nThe URL of this endpoint should not be considered as fixed. Instead, use the [Create zip download](/reference/post-zip-downloads) API to request to create a `zip` archive, and then follow the `status_url` field in the response to this endpoint.","href":"/reference/get-zip-downloads-id-status"},{"title":"Create zip download","openapi":"box-openapi.json POST /zip_downloads","description":"Creates a request to download multiple files and folders as a single `zip` archive file. This API does not return the archive but instead performs all the checks to ensure that the user has access to all the items, and then returns a `download_url` and a `status_url` that can be used to download the archive.\n\nThe limit for an archive is either the Account's upload limit or 10,000 files, whichever is met first.\n\n**Note**: Downloading a large file can be affected by various factors such as distance, network latency, bandwidth, and congestion, as well as packet loss ratio and current server load. For these reasons we recommend that a maximum ZIP archive total size does not exceed 25GB.","href":"/reference/post-zip-downloads"}]}]},{"group":"v2025.0","pages":[{"group":"Archives","root":{"title":"Archives resources","description":null,"href":"/reference/v2025.0/archives-resources"},"pages":[{"title":"List archives","openapi":"box-openapi-v2025.0.json GET /archives","description":"Retrieves archives for an enterprise.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).","href":"/reference/v2025.0/get-archives"},{"title":"Create archive","openapi":"box-openapi-v2025.0.json POST /archives","description":"Creates an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).","href":"/reference/v2025.0/post-archives"},{"title":"Update archive","openapi":"box-openapi-v2025.0.json PUT /archives/{archive_id}","description":"Updates an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).","href":"/reference/v2025.0/put-archives-id"},{"title":"Delete archive","openapi":"box-openapi-v2025.0.json DELETE /archives/{archive_id}","description":"Permanently deletes an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).\n\n\u003cDanger>\nThis endpoint is currently unavailable. Please contact support for assistance.\n\u003c/Danger>","href":"/reference/v2025.0/delete-archives-id"}]},{"group":"Box Doc Gen","root":{"title":"Box Doc Gen resources","description":null,"href":"/reference/v2025.0/docgen-resources"},"pages":[{"title":"Get Box Doc Gen job by ID","openapi":"box-openapi-v2025.0.json GET /docgen_jobs/{job_id}","description":"Get details of the Box Doc Gen job.","href":"/reference/v2025.0/get-docgen-jobs-id"},{"title":"Get Box Doc Gen jobs by batch ID","openapi":"box-openapi-v2025.0.json GET /docgen_batch_jobs/{batch_id}","description":"Lists Box Doc Gen jobs in a batch.","href":"/reference/v2025.0/get-docgen-batch-jobs-id"},{"title":"List all Box Doc Gen jobs","openapi":"box-openapi-v2025.0.json GET /docgen_jobs","description":"Lists all Box Doc Gen jobs for a user.","href":"/reference/v2025.0/get-docgen-jobs"},{"title":"Generate document using Box Doc Gen template","openapi":"box-openapi-v2025.0.json POST /docgen_batches","description":"Generates a document using a Box Doc Gen template.","href":"/reference/v2025.0/post-docgen-batches"}]},{"group":"Box Doc Gen templates","root":{"title":"Box Doc Gen templates resources","description":null,"href":"/reference/v2025.0/docgen-template-resources"},"pages":[{"title":"Get Box Doc Gen template by ID","openapi":"box-openapi-v2025.0.json GET /docgen_templates/{template_id}","description":"Lists details of a specific Box Doc Gen template.","href":"/reference/v2025.0/get-docgen-templates-id"},{"title":"Get list of all Box Doc Gen jobs for template","openapi":"box-openapi-v2025.0.json GET /docgen_template_jobs/{template_id}","description":"Lists the users jobs which use this template.","href":"/reference/v2025.0/get-docgen-template-jobs-id"},{"title":"List all Box Doc Gen template tags in template","openapi":"box-openapi-v2025.0.json GET /docgen_templates/{template_id}/tags","description":"Lists all tags in a Box Doc Gen template.","href":"/reference/v2025.0/get-docgen-templates-id-tags"},{"title":"List Box Doc Gen templates","openapi":"box-openapi-v2025.0.json GET /docgen_templates","description":"Lists Box Doc Gen templates on which the user is a collaborator.","href":"/reference/v2025.0/get-docgen-templates"},{"title":"Create Box Doc Gen template","openapi":"box-openapi-v2025.0.json POST /docgen_templates","description":"Marks a file as a Box Doc Gen template.","href":"/reference/v2025.0/post-docgen-templates"},{"title":"Delete Box Doc Gen template","openapi":"box-openapi-v2025.0.json DELETE /docgen_templates/{template_id}","description":"Unmarks file as Box Doc Gen template.","href":"/reference/v2025.0/delete-docgen-templates-id"}]},{"group":"Box Hub Collaborations","root":{"title":"Box Hub Collaborations resources","description":null,"href":"/reference/v2025.0/hub-collaborations-resources"},"pages":[{"title":"Get Box Hub collaboration by collaboration ID","openapi":"box-openapi-v2025.0.json GET /hub_collaborations/{hub_collaboration_id}","description":"Retrieves details for a Box Hub collaboration by collaboration ID.","href":"/reference/v2025.0/get-hub-collaborations-id"},{"title":"Get Box Hub collaborations","openapi":"box-openapi-v2025.0.json GET /hub_collaborations","description":"Retrieves all collaborations for a Box Hub.","href":"/reference/v2025.0/get-hub-collaborations"},{"title":"Create Box Hub collaboration","openapi":"box-openapi-v2025.0.json POST /hub_collaborations","description":"Adds a collaboration for a single user or a single group to a Box Hub.\n\nCollaborations can be created using email address, user IDs, or group IDs.","href":"/reference/v2025.0/post-hub-collaborations"},{"title":"Update Box Hub collaboration","openapi":"box-openapi-v2025.0.json PUT /hub_collaborations/{hub_collaboration_id}","description":"Updates a Box Hub collaboration. Can be used to change the Box Hub role.","href":"/reference/v2025.0/put-hub-collaborations-id"},{"title":"Remove Box Hub collaboration","openapi":"box-openapi-v2025.0.json DELETE /hub_collaborations/{hub_collaboration_id}","description":"Deletes a single Box Hub collaboration.","href":"/reference/v2025.0/delete-hub-collaborations-id"}]},{"group":"Box Hub Document","root":{"title":"Box Hub Document resources","description":null,"href":"/reference/v2025.0/hub-document-resources"},"pages":[{"title":"List Hub Document blocks for page","openapi":"box-openapi-v2025.0.json GET /hub_document_blocks","description":"Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items. Blocks are hierarchically organized by their `parent_id`. Blocks are sorted in order based on user specification in the user interface. The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks.","href":"/reference/v2025.0/get-hub-document-blocks"},{"title":"List Hub Document Pages","openapi":"box-openapi-v2025.0.json GET /hub_document_pages","description":"Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages.","href":"/reference/v2025.0/get-hub-document-pages"}]},{"group":"Box Hub Items","root":{"title":"Box Hub Items resources","description":null,"href":"/reference/v2025.0/hub-items-resources"},"pages":[{"title":"Get Box Hub items","openapi":"box-openapi-v2025.0.json GET /hub_items","description":"Retrieves all items associated with a Box Hub.","href":"/reference/v2025.0/get-hub-items"},{"title":"Manage Box Hub items","openapi":"box-openapi-v2025.0.json POST /hubs/{hub_id}/manage_items","description":"Adds and/or removes Box Hub items from a Box Hub.","href":"/reference/v2025.0/post-hubs-id-manage-items"}]},{"group":"Box Hubs","root":{"title":"Box Hubs resources","description":null,"href":"/reference/v2025.0/hubs-resources"},"pages":[{"title":"Get Box Hub information by ID","openapi":"box-openapi-v2025.0.json GET /hubs/{hub_id}","description":"Retrieves details for a Box Hub by its ID.","href":"/reference/v2025.0/get-hubs-id"},{"title":"List all Box Hubs","openapi":"box-openapi-v2025.0.json GET /hubs","description":"Retrieves all Box Hubs for requesting user.","href":"/reference/v2025.0/get-hubs"},{"title":"List all Box Hubs for requesting enterprise","openapi":"box-openapi-v2025.0.json GET /enterprise_hubs","description":"Retrieves all Box Hubs for a given enterprise.\n\nAdmins or Hub Co-admins of an enterprise with GCM scope can make this call.","href":"/reference/v2025.0/get-enterprise-hubs"},{"title":"Copy Box Hub","openapi":"box-openapi-v2025.0.json POST /hubs/{hub_id}/copy","description":"Creates a copy of a Box Hub.\n\nThe original Box Hub will not be modified.","href":"/reference/v2025.0/post-hubs-id-copy"},{"title":"Create Box Hub","openapi":"box-openapi-v2025.0.json POST /hubs","description":"Creates a new Box Hub.","href":"/reference/v2025.0/post-hubs"},{"title":"Update Box Hub information by ID","openapi":"box-openapi-v2025.0.json PUT /hubs/{hub_id}","description":"Updates a Box Hub. Can be used to change title, description, or Box Hub settings.","href":"/reference/v2025.0/put-hubs-id"},{"title":"Delete Box Hub","openapi":"box-openapi-v2025.0.json DELETE /hubs/{hub_id}","description":"Deletes a single Box Hub.","href":"/reference/v2025.0/delete-hubs-id"}]},{"group":"Enterprise Configurations","root":{"title":"Enterprise Configurations resources","description":null,"href":"/reference/v2025.0/enterprise-configurations-resources"},"pages":[{"title":"Get enterprise configuration","openapi":"box-openapi-v2025.0.json GET /enterprise_configurations/{enterprise_id}","description":"Retrieves the configuration for an enterprise.","href":"/reference/v2025.0/get-enterprise-configurations-id"}]},{"group":"External Users","root":{"title":"External Users resources","description":null,"href":"/reference/v2025.0/external-users-resources"},"pages":[{"title":"Submit job to delete external users","openapi":"box-openapi-v2025.0.json POST /external_users/submit_delete_job","description":"Delete external users from current user enterprise. This will remove each external user from all invited collaborations within the current enterprise.","href":"/reference/v2025.0/post-external-users-submit-delete-job"}]},{"group":"Shield lists","root":{"title":"Shield lists resources","description":null,"href":"/reference/v2025.0/shield-lists-resources"},"pages":[{"title":"Get all shield lists in enterprise","openapi":"box-openapi-v2025.0.json GET /shield_lists","description":"Retrieves all shield lists in the enterprise.","href":"/reference/v2025.0/get-shield-lists"},{"title":"Get single shield list by shield list id","openapi":"box-openapi-v2025.0.json GET /shield_lists/{shield_list_id}","description":"Retrieves a single shield list by its ID.","href":"/reference/v2025.0/get-shield-lists-id"},{"title":"Create shield list","openapi":"box-openapi-v2025.0.json POST /shield_lists","description":"Creates a shield list.","href":"/reference/v2025.0/post-shield-lists"},{"title":"Update shield list","openapi":"box-openapi-v2025.0.json PUT /shield_lists/{shield_list_id}","description":"Updates a shield list.","href":"/reference/v2025.0/put-shield-lists-id"},{"title":"Delete single shield list by shield list id","openapi":"box-openapi-v2025.0.json DELETE /shield_lists/{shield_list_id}","description":"Delete a single shield list by its ID.","href":"/reference/v2025.0/delete-shield-lists-id"}]}]},{"group":"v2026.0","pages":[{"group":"Automate Workflows","tag":"Beta","pages":[{"title":"List Automate workflows defined as callable actions","openapi":"box-openapi-v2026.0.json GET /automate_workflows","tag":"Beta","description":"Returns workflow actions from Automate for a folder, using the `WORKFLOW` action category.","href":"/reference/v2026.0/get-automate-workflows"},{"title":"Start Automate workflow","openapi":"box-openapi-v2026.0.json POST /automate_workflows/{workflow_id}/start","tag":"Beta","description":"Starts an Automate workflow manually by using a workflow action ID and file IDs.","href":"/reference/v2026.0/post-automate-workflows-id-start"}]},{"group":"Convert to Box note","root":{"title":"Convert to Box note resources","description":null,"href":"/reference/v2026.0/notes-resources"},"pages":[{"title":"Convert content to Box Note","openapi":"box-openapi-v2026.0.json POST /notes/convert","description":"Creates a Box Note (`.boxnote` file) from supported source content. See the `content_format` field for supported formats.","href":"/reference/v2026.0/post-notes-convert"}]},{"group":"Query","root":{"title":"Query resources","description":null,"href":"/reference/v2026.0/query-resources"},"pages":[{"title":"Box Query","openapi":"box-openapi-v2026.0.json POST /query","description":"Runs a query to discover Box items using a logical predicate, similar to a SQL WHERE clause. The predicate can filter across multiple metadata templates and item fields in a single request. Results can be sorted, paginated with markers, and shaped with fields so each entry includes additional item or metadata attributes.\n\nThis is the item-retrieval endpoint in the Query API (version 2026.0). Unlike the [Metadata Query API](/reference/post-metadata-queries-execute-read), it is not limited to a single metadata template or to files and folders. For totals and grouped metrics over the same predicates, use [Query Insights](/reference/v2026.0/post-query-insights) instead of paging through every matching item.\n\nFor predicate syntax, parameters, examples, pagination behavior, and error codes, see the [Box Query guide](/guides/query/box-query). For shared response schemas, including Query results and result entries, see [Query resources](/reference/v2026.0/query-resources).","href":"/reference/v2026.0/post-query"},{"title":"Create insights for Box items","openapi":"box-openapi-v2026.0.json POST /query_insights","description":"Computes aggregated metrics over Box items matching a query predicate. Filters are applied first, followed by optional grouping, after which the requested metrics (such as `sum`, `avg`, `min`, `max`, and `count`) are computed for each resulting group or over the entire filtered dataset.","href":"/reference/v2026.0/post-query-insights"}]}]}]},{"tab":"Tools","pages":[{"group":"Dev tools","pages":[{"title":"Tools","sidebarTitle":"Tools","description":"The following SDKs and tools are developed and supported by Box","timestamp":false,"href":"/sdks-and-tools"},{"group":"SDKs","pages":[{"title":"Box SDKs","description":null,"href":"/guides/tooling/sdks/index"},{"title":"Box SDK versioning strategy","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/tooling/sdks/sdk-versioning"},{"title":"Install .NET SDK","sidebarTitle":".NET SDK","related_pages":null,"description":null,"href":"/guides/tooling/sdks/dotnet"},{"title":"Box Java SDK","sidebarTitle":"Java SDK","description":"Install the Box Java SDK with Maven or Gradle and start calling the Box API from a Java application.","related_pages":["sdks-and-tools"],"href":"/guides/tooling/sdks/java"},{"title":"Install Python SDK","sidebarTitle":"Python SDK","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/tooling/sdks/python"},{"title":"Install Node SDK","sidebarTitle":"Node SDK","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/tooling/sdks/node"},{"title":"Install Salesforce SDK","sidebarTitle":"Salesforce SDK","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/tooling/sdks/salesforce"},{"group":"Deprecated","pages":[{"title":"Deprecated Box Next Gen TypeScript SDK","sidebarTitle":"Box Next Gen TypeScript SDK","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/tooling/sdks/typescript-gen"},{"title":"Deprecated Box Next Gen Python SDK","sidebarTitle":"Box Next Gen Python SDK","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/tooling/sdks/python-gen"},{"title":"Deprecated Box Next Gen .NET SDK","sidebarTitle":"Box Next Gen .NET SDK","related_pages":null,"description":null,"href":"/guides/tooling/sdks/dotnet-gen"},{"title":"Deprecated Box Next Gen Java SDK","sidebarTitle":"Box Next Gen Java SDK","related_pages":null,"description":null,"href":"/guides/tooling/sdks/java-gen"},{"title":"Deprecated Box Next Gen Swift SDK","sidebarTitle":"Box Next Gen Swift SDK","related_pages":null,"description":null,"href":"/guides/tooling/sdks/swift-gen"}]}]},{"title":"The `box` npm package","description":"What `npm install box` provides, how to use the bundled SDK and CLI, and what existing `box-node-sdk` users need to know.","href":"/guides/tooling/box-npm-package"},{"group":"CLI","pages":[{"title":"Box CLI","sidebarTitle":"Overview","description":"Install the Box CLI with npm and use it from your terminal, scripts, and AI agents to manage Box content.","href":"/guides/cli/index"},{"title":"Login for Headless Environments","sidebarTitle":"Headless Login","description":null,"href":"/guides/cli/headless-login"},{"group":"Using the Box CLI","pages":[{"title":"Building Commands and Help Feature","type":"quick-start","sidebarTitle":"Building Commands and Help Feature","hide_in_page_nav":true,"description":null,"href":"/guides/cli/quick-start/build-commands-help"},{"title":"Using Options","sidebarTitle":"Using Options","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/cli/quick-start/using-options"},{"title":"Using Bulk Commands","sidebarTitle":"Using Bulk Commands","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/cli/quick-start/using-bulk-commands"}]},{"group":"CLI sample scripts","pages":[{"title":"CLI sample scripts","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/index"},{"title":"Using PowerShell Scripts with the Box CLI","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/powershell-script-templates"},{"title":"Update user zones","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/user-zones-mass-update"},{"title":"Report inactive users","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/report-inactive-users"},{"title":"Manage groups and collaborations","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/manage-groups-collaborations"},{"title":"Extract metadata","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/metadata-extraction"},{"title":"Deprovision users and archive folders","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/deprovision-users"},{"title":"Manage Slack integration folder mappings","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/scripts/slack-integration-mappings"}]},{"group":"Box CLI with JWT Authentication","pages":[{"title":"Box CLI with JWT Authentication","related_pages":["sdks-and-tools"],"description":null,"href":"/guides/cli/cli-with-jwt-authentication/jwt-cli"}]}]},{"title":"Box Mount","sidebarTitle":"Box Mount","description":"Mount a Box folder into an agent runtime as a POSIX filesystem, kept in two-way sync, with Box permissions and governance applied to every operation.","tag":"Preview","href":"/guides/box-mount"},{"group":"Box UI Elements","pages":[{"title":"UI Elements","sidebarTitle":"Overview","description":null,"href":"/guides/embed/ui-elements/index"},{"title":"Installation","description":null,"href":"/guides/embed/ui-elements/installation"},{"title":"Browser Support","description":null,"href":"/guides/embed/ui-elements/browser"},{"group":"Content Explorer","pages":[{"title":"Content Explorer","description":null,"href":"/guides/embed/ui-elements/explorer"},{"title":"Content Explorer – metadata view v2","description":null,"href":"/guides/embed/ui-elements/explorer-metadata-v2"},{"title":"Content Explorer - metadata view v1","description":null,"href":"/guides/embed/ui-elements/explorer-metadata-v1"}]},{"title":"Content Open With","description":null,"href":"/guides/embed/ui-elements/open-with"},{"title":"Content Picker","description":null,"href":"/guides/embed/ui-elements/picker"},{"title":"Content Preview","description":null,"href":"/guides/embed/ui-elements/preview"},{"title":"Content Sidebar","description":null,"href":"/guides/embed/ui-elements/sidebar"},{"title":"Content Uploader","description":null,"href":"/guides/embed/ui-elements/uploader"},{"title":"Annotations","description":null,"href":"/guides/embed/ui-elements/annotations"},{"title":"Customize Logo","description":null,"href":"/guides/embed/ui-elements/logo"},{"title":"Theming \u0026 styling for Box UI Elements","description":null,"href":"/guides/embed/ui-elements/theming-styling"},{"title":"UI Elements design tokens","description":null,"href":"/guides/embed/ui-elements/ui-elements-design-tokens"},{"title":"Customize Access","description":null,"href":"/guides/embed/ui-elements/access"},{"title":"Dedicated Scopes","description":null,"href":"/guides/embed/ui-elements/scopes"},{"title":"Preview - Viewers \u0026 Events","hide_in_page_nav":true,"description":null,"href":"/guides/embed/ui-elements/viewers-and-events"},{"title":"Box Edit Custom Domains","description":null,"href":"/guides/embed/ui-elements/custom-domains"}]},{"group":"Salesforce Developer Toolkit","pages":[{"title":"Salesforce Developer Toolkit","description":null,"href":"/guides/tooling/salesforce-toolkit/index"},{"title":"Methods and Operations","description":"Reference for Box for Salesforce Developer Toolkit methods and operations.","href":"/guides/tooling/salesforce-toolkit/methods"},{"title":"Code Samples","description":null,"href":"/guides/tooling/salesforce-toolkit/samples"},{"group":"Experience Cloud Toolkit","pages":[{"title":"Experience Cloud Toolkit Global Methods","description":"The `ExperienceCloudToolkit` class provides global methods for managing Box App Users within Salesforce Experience Cloud environments.","href":"/guides/tooling/salesforce-toolkit/experience-cloud-toolkit/experience-cloud-toolkit-global-methods"}]},{"group":"Flow Actions","pages":[{"title":"Flow Actions","description":null,"href":"/guides/tooling/salesforce-toolkit/flow-actions"},{"title":"Push File to Box","description":null,"href":"/guides/tooling/salesforce-toolkit/flow-actions/push-file-to-box"}]},{"title":"UI Elements in Salesforce","description":null,"href":"/guides/tooling/salesforce-toolkit/ui-elements"},{"title":"Box for Agentforce Extension package","description":null,"href":"/guides/tooling/salesforce-toolkit/box-agentforce-package"},{"title":"Wiring the Box file picker to a custom invocable","description":null,"href":"/guides/tooling/salesforce-toolkit/wiring-the-box-file-picker-to-a-custom-invocable"},{"title":"Box Doc Gen Toolkit","description":null,"href":"/guides/tooling/salesforce-toolkit/doc-gen-toolkit"}]},{"group":"Postman Collection","pages":[{"title":"Postman Collection","sidebarTitle":"Overview","description":null,"href":"/guides/tooling/postman/index"},{"title":"Refresh an Access Token","description":null,"href":"/guides/tooling/postman/refresh"}]},{"group":"Mobile","pages":[{"title":"Deep Linking","description":null,"href":"/guides/mobile/mobile-deep-linking"},{"group":"Android","pages":[{"title":"Android","related_pages":"None","sidebarTitle":"Overview","description":null,"href":"/guides/mobile/android/index"},{"title":"Android SDK Installation","related_pages":null,"description":null,"href":"/guides/mobile/android/install"}]},{"group":"iOS","pages":[{"title":"iOS","related_pages":"None","sidebarTitle":"Overview","description":null,"href":"/guides/mobile/ios/index"},{"group":"Learn to use the iOS SDK","pages":[{"title":"Learn to use the iOS SDK","type":"quick-start","hide_step_number":true,"hide_in_page_nav":true,"sidebarTitle":"Overview","description":null,"href":"/guides/mobile/ios/quick-start/index"},{"title":"Create an iOS App","sidebarTitle":"1. Create an iOS App","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/mobile/ios/quick-start/create-ios-app"},{"title":"Install the iOS SDK","sidebarTitle":"2. Install the iOS SDK","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/mobile/ios/quick-start/install-ios-sdk"},{"title":"Configure a platform app","sidebarTitle":"3. Configure a platform app","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/mobile/ios/quick-start/configure-box-app"},{"title":"Make an API call","sidebarTitle":"4. Make an API call","type":"quick-start","hide_in_page_nav":true,"description":null,"href":"/guides/mobile/ios/quick-start/make-api-call"},{"title":"iOS quick start: next steps","sidebarTitle":"Next steps","type":"quick-start","hide_step_number":true,"description":null,"href":"/guides/mobile/ios/quick-start/next-steps"}]}]}]},{"title":"Box Embed","description":null,"href":"/guides/embed/box-embed"},{"group":"Box View","pages":[{"title":"Box View","sidebarTitle":"Overview","description":null,"href":"/guides/embed/box-view/index"},{"title":"Setup","description":null,"href":"/guides/embed/box-view/setup"},{"title":"Create File Preview","description":null,"href":"/guides/embed/box-view/create-preview"},{"title":"Upload Files","description":null,"href":"/guides/embed/box-view/upload-file"},{"title":"Box View best practices","sidebarTitle":"Best practices","description":null,"href":"/guides/embed/box-view/best-practices"},{"title":"FAQ","description":null,"href":"/guides/embed/box-view/faq"}]}]}]},{"tab":"Tutorials","pages":[{"title":"Box Tutorials","description":"End-to-end tutorials that walk you through building real applications with Box APIs, from first API call to production-ready integration.","mode":"wide","timestamp":false,"href":"/tutorials"},{"title":"Automate invoice intake with Box AI Extract","sidebarTitle":"Invoice intake automation","description":null,"href":"/tutorials/invoice-intake"},{"title":"Build an answer bank with Box Hubs and AI","sidebarTitle":"AI-powered answer bank","description":"Build an AI-powered answer bank that indexes curated content in a Box Hub and answers questions with Box AI. This walkthrough uses a sales RFP library as the example.","href":"/tutorials/sales-rfp-answer-bank"},{"title":"Build secure in-app document review with Box View","sidebarTitle":"Secure in-app document review","description":"Upload documents to Box, embed a secure expiring preview in your own app, and add in-context annotations with Box Content Preview.","href":"/tutorials/secure-in-app-document-review"},{"title":"Turn supplier agreements into structured procurement data with Box AI","sidebarTitle":"Supplier agreement extraction","description":"Extract grouped vendor details and repeating delivery schedules from supplier agreements using the struct and table field types in Box AI structured extraction.","href":"/tutorials/supplier-agreements"},{"title":"Automate new hire onboarding with Box APIs","sidebarTitle":"Automate new hire onboarding","description":"Build a middleware service that listens for HR hiring events and provisions a standardized, governed Box workspace for every new hire using the Users, Groups, Folders, and Collaboration APIs.","href":"/tutorials/onboarding-workspaces"},{"title":"Automate offer letter creation with Box Doc Gen and Box Sign","sidebarTitle":"Offer letter automation","description":"Build an HR workflow that generates offer letters with Box Doc Gen, routes them through Box Sign for HR approval, and delivers them to candidates for signature.","href":"/tutorials/offer-letter-creation"},{"title":"Build an NDA risk summary with Box AI Extract","sidebarTitle":"NDA risk summary","description":"Extract key clauses from an NDA or MSA with Box AI structured extraction, turn them into a Deal Risk Summary as JSON and markdown, and save the summary back to Box as a companion file.","href":"/tutorials/nda-risk-summary"},{"title":"Build your company brain","sidebarTitle":"Build your company brain","description":"Turn scattered company content into governed knowledge. Review new files with Box AI and publish approved content to Box Hubs, allowing humans and AI agents to work from the same trusted source.","href":"/tutorials/company-brain"},{"title":"Route claims evidence for review with Box Automate","sidebarTitle":"Claims evidence review","description":"Build a claims service that runs an automated approval workflow. Box handles the approval or rejection of tasks. Your app chooses the files and starts the review.","href":"/tutorials/claims-evidence-review"},{"title":"Connect an AI agent to Box","description":"Connect a coding or autonomous agent to a Box developer account through OAuth with the Box CLI or Box MCP server.","href":"/tutorials/connect-an-agent-to-box"},{"title":"Create a review workflow in Box Automate with Slack notifications","sidebarTitle":"Create workflow Automate and Slack","description":"Build a review workflow with Box Automate that routes files through approval tasks, sends notifications in Box, and posts updates to a Slack channel using HTTPS Request outcomes.","href":"/tutorials/box-automate-review-workflow"},{"title":"Build a document dashboard with the Content Explorer metadata view","sidebarTitle":"Document metadata dashboard","description":"Embed the enhanced metadata view of the Box Content Explorer to browse, filter, and edit documents by their metadata, with a single setup script and one HTML page.","href":"/tutorials/explorer-metadata-view"},{"title":"Extract EXIF metadata with Box representations","sidebarTitle":"Extract EXIF metadata","description":"Extract embedded technical metadata such as EXIF, then write selected fields to a Box metadata template so you can filter them in a Box Apps dashboard.","href":"/tutorials/extract-exif-metadata"}]},{"tab":"Changelog","pages":[{"title":"2026","description":"Box Platform changelog: API, SDK, and product updates from 2026.","rss":true,"href":"/changelog/2026"},{"title":"2025","description":"Box Platform changelog: API, SDK, and product updates from 2025.","rss":true,"href":"/changelog/2025"},{"title":"2024","description":"Box Platform changelog: API, SDK, and product updates from 2024.","rss":true,"href":"/changelog/2024"},{"title":"2023","description":"Box Platform changelog: API, SDK, and product updates from 2023.","rss":true,"href":"/changelog/2023"},{"title":"2022","description":"Box Platform changelog: API, SDK, and product updates from 2022.","rss":true,"href":"/changelog/2022"},{"title":"2021","description":"Box Platform changelog: API, SDK, and product updates from 2021.","rss":true,"href":"/changelog/2021"},{"title":"2020","description":"Box Platform changelog: API, SDK, and product updates from 2020.","rss":true,"href":"/changelog/2020"},{"title":"2019","description":"Box Platform changelog: API, SDK, and product updates from 2019.","rss":true,"href":"/changelog/2019"},{"title":"2018","description":"Box Platform changelog: API, SDK, and product updates from 2018.","rss":true,"href":"/changelog/2018"}]}],"global":{"anchors":[{"anchor":"Box","icon":"https://mintlify.s3.us-west-1.amazonaws.com/box/images/sidebar/box.svg","href":"https://www.box.com/home"},{"anchor":"Community","icon":"book-open-cover","href":"https://community.box.com/box-platform-5"},{"anchor":"Developer Blog","icon":"newspaper","href":"https://blog.box.com/developer"},{"anchor":"Box SDKs","icon":"code","href":"https://github.com/box/sdks"},{"anchor":"Box Docs","icon":"file-lines","href":"https://docs.box.com"}]}},{"language":"ja","footer":{"socials":{"x":"https://x.com/box","github":"https://github.com/box-community","linkedin":"https://linkedin.com/company/box","youtube":"https://www.youtube.com/user/box","facebook":"https://www.facebook.com/box"},"links":[{"header":"リソース","items":[{"label":"ニュースレターの登録解除","href":"https://go.box.com/preferences.html"},{"label":"利用規約","href":"https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9"},{"label":"個人情報保護方針","href":"https://www.box.com/en-gb/legal/privacypolicy?url_redirect=direct"},{"label":"Cookieに関する通知","href":"https://www.box.com/en-gb/legal/cookie-notification?url_redirect=direct"},{"label":"llms.txt","href":"https://developer.box.com/llms.txt"}]}]},"navbar":{"links":[{"href":"https://account.box.com/developers/console","label":"ログイン","type":"button"}],"primary":{"type":"button","label":"今すぐ無料で開始","href":"https://account.box.com/signup/developer#ty9l3"}},"pages":[{"title":"ja","href":"/ja"}]}]},"title":"サンプルコードカタログ - Box Dev Docs","buildId":"dpl_AEzG1ss5XJooq2b7ZjQnALs8YZd6","deploymentId":"dpl_AEzG1ss5XJooq2b7ZjQnALs8YZd6","dynamics":["10e4515597"],"chunks":["BannerMarkdown-WoIAKPdX.js","dist-ieWvBjkL.js","lib-hPeS2WON.js","lib-vtHBCq3V.js","clsx-BC7mgnCW.js","html-void-elements-mCSPHezU.js","marked.esm-BKo0Hl1x.js"]}