{"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","banner":{"content":"Join live webinar on Sept 29: See how to give agents a computer and enterprise content to work on with Box and Daytona. [Register now](https://events.zoom.us/ev/Amkp36LSSk_TxOQbBytoLoHa_Ztg7quKlJv2u74NRvSZJtlnbG5L~AqO7fnFo-ePaTqEcPrKs4jSfhxq3pMVK52ut69Q2zfn9jOr70vx5DQVJaeNF1dDZE9_0N33jMcY1yE9LoHDL5Oamqg).","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":"リソース","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"}},"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":"6ad205fd1f1c7c233eab5d16","collectionId":"299b69f0-b932-48aa-9f7f-01b0b094a68c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad205fd1f1c7c233eab5d16"},"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":"6ad205fd1f1c7c233eab5d16","clientVersion":"0.0.3865","searchFilterCounts":[{"language":"en","tag":"API reference","count":638},{"language":"en","tag":"Home","count":368},{"language":"ja","tag":"ホーム","count":368},{"language":"ja","tag":"APIリファレンス","count":339},{"language":"en","tag":"AI","count":193},{"language":"ja","tag":"AI","count":187},{"language":"ja","tag":"コラボレーション","count":81},{"language":"en","tag":"Tools","count":77},{"language":"en","tag":"Dev tools","count":77},{"language":"ja","tag":"ツール","count":76},{"language":"ja","tag":"開発ツール","count":76},{"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":47},{"language":"ja","tag":"サポートされているAIモデル","count":44}]},"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":"editor-nav-generations","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":"vite-origin","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,"googleFontsInlined":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":"reference/avatars-resources","slug":"/reference/avatars-resources","pageMetadata":{"title":"User avatars resources","description":null,"href":"/reference/avatars-resources"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Accordion,CodeBlock,Heading,Table}=_components;if(!Accordion)_missingMdxReference(`Accordion`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`User avatars are JPG or PNG files uploaded to Box to represent the user image. They are then displayed in the user account.`}),`\n`,_jsx(Heading,{level:`2`,id:`user-avatar`,children:`User avatar`}),`\n`,_jsx(_components.p,{children:`A resource holding URLs to the avatar uploaded to a Box application.`}),`\n`,_jsxs(Accordion,{title:`Attributes and example`,id:`attributes-and-example`,children:[_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Property`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`pic_urls`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`object`})}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`Represents an object with user avatar URLs.`})]})})]}),_jsx(CodeBlock,{filename:`Example`,numberOfLines:`7`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`7`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"pic_urls\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"small\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://app.box.com/index.php?rm=pic_storage_auth\u0026pic=euks! pac3kv01!7B6R5cZLmurEV_xB-KkycPk8Oi7oENUX2O_qUtIuO4342CG IldyCto9hqiQP7uxqYU5V2w63Ft4ln4UVVLDtDZu903OqzkflY2O-Lq00 ubA29xU-RJ6b_KzJEWRYgUhX1zEl3dzWo12g8eWRE2rStf123DF7AYahNqM 1BmLmviL_nODc7SDQHedTXPAjxURUAra5BvtLe7B05AizbNXdPlCNp-LNh _S-eZ_RjDXcGO-MkRWd_3BOMHnvjf450t5BfKoJ15WhEfiMlfXH1tmouHXrsC 66cT6-pzF9E40Iir_zThqSlrFxzP_xcmXzHapr_k-0E2qr2TXp4iC396TSlEw`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"large\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://app.box.com/index.php?rm=pic_storage_auth\u0026pic=euks`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`pac3kv01!lipGQlQQOtCTCoB6zCOArUjVWLFJtLr5tn6aOZMCybhRx0NNuFQbVI36nw`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`jtEk5YjUUz1KVdVuvU2yDhu_ftK_bvxeKP1Ffrx9vKGVvJ-UJc1z32p6n2CmFzzpc`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`gSoX4pnPhFgydAL-u9jDspXUGElr-htDG_HPMiE9DZjqDueOxXHy8xe22wbaPAheC`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`ao1emv8r_fmufaUgSndeMYmyZj-KqOYsLBrBNgdeiK5tZmPOQggAEUmyQPkrd8W92TQ6sSlIp0r\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"preview\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://app.box.com/index.php?rm=pic_storage_auth\u0026pic=euks!`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`pac3kv01!8UcNPweOOAWj2DtHk_dCQB4wJpzyPkl7mT5nHj5ZdjY92ejYCBBZc95--403b29CW`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`k-8hSo_uBjh5h9QG42Ihu-cOZ-816sej1kof3SOm5gjn7qjMAx89cHjUaNK-6XasRqSNboenjZ`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`04laZuV9vSH12BZGAYycIZvvQ5R66Go8xG5GTMARf2nBU84c4H_SL5iws-HeBS4oQJWOJh6FBl`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`sSJDSTI74LGXqeZb3EY_As34VFC95F10uozoTOSubZmPYylPlaKXoKWk2f9wYQso1ZTN7sh-Gc`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\n`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`9Kp43zMLhArIWhok0Im6FlRAuWOQ03KYgL-k4L5EZp4Gw6B7uqVRwcBbsTwMIorWq1g\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{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":{"title":"User avatars resources","description":null,"href":"/reference/avatars-resources"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"User avatar","slug":"user-avatar","depth":2,"children":[]}],"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/d88c3906cf95ec86/snippets/translations.js","/_mintlify/custom/box/d67e74fc334b686a/scripts/preferred-source.js"],"subdomain":"box","siteName":"Box Dev Docs","title":"User avatars resources - Box Dev Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/avatars-resources","matchLevel":0},"ja":{"href":"/reference/avatars-resources","matchLevel":0}}},"lastModified":"2026-10-16T10:43:49.911Z","gitLastModified":"2026-07-09T13:04:50.000Z","originalFileLocation":"reference/avatars-resources.mdx","locale":"en"},"headHtml":"\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=\"User avatars resources - Box Dev Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Box Dev Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.box.com/reference/avatars-resources\">\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=\"User avatars resources - Box Dev Docs\">\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/reference/avatars-resources\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/avatars-resources.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.box.com/#organization\",\"name\":\"Box Dev Docs\",\"url\":\"https://developer.box.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/box/lJLw9z7FWORNWMcq/logo/boxdev-light.png?fit=max\u0026auto=format\u0026n=lJLw9z7FWORNWMcq\u0026q=85\u0026s=a11710b698ff59d24426f9ecec6c7e9c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.box.com#website\",\"name\":\"Box Dev Docs\",\"url\":\"https://developer.box.com\",\"publisher\":{\"@id\":\"https://developer.box.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.box.com/reference/avatars-resources#webpage\",\"url\":\"https://developer.box.com/reference/avatars-resources\",\"name\":\"User avatars resources\",\"dateModified\":\"2026-07-09T13:04:50.000Z\",\"isPartOf\":{\"@id\":\"https://developer.box.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.box.com/reference/avatars-resources#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.box.com/reference/avatars-resources#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://developer.box.com/reference/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"User avatars resources\",\"item\":\"https://developer.box.com/reference/avatars-resources\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developer.box.com/reference/avatars-resources#article\",\"headline\":\"User avatars resources\",\"name\":\"User avatars resources\",\"url\":\"https://developer.box.com/reference/avatars-resources\",\"mainEntityOfPage\":{\"@id\":\"https://developer.box.com/reference/avatars-resources#webpage\"},\"dateModified\":\"2026-07-09T13:04:50.000Z\",\"publisher\":{\"@id\":\"https://developer.box.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.box.com#website\"}}]}\u003c/script>","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","href":""}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai"}]},{"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":[{"title":"Tools","href":"/sdks-and-tools"}]},{"tab":"Tutorials","pages":[{"title":"Tutorials","href":"/tutorials"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/2026"}]}],"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","banner":{"content":"Join live webinar on Sept 29: See how to give agents a computer and enterprise content to work on with Box and Daytona. [Register now](https://events.zoom.us/ev/Amkp36LSSk_TxOQbBytoLoHa_Ztg7quKlJv2u74NRvSZJtlnbG5L~AqO7fnFo-ePaTqEcPrKs4jSfhxq3pMVK52ut69Q2zfn9jOr70vx5DQVJaeNF1dDZE9_0N33jMcY1yE9LoHDL5Oamqg).","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":"リソース","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"}},"tabs":[{"tab":"ホーム","pages":[{"title":"ホーム","href":"/ja"}]},{"tab":"AI","pages":[{"title":"AI","href":"/ja/ai"}]},{"tab":"APIリファレンス","groups":[{"group":" ","pages":[{"title":"APIリファレンス","alias_paths":[],"sidebarTitle":"v2024.0","description":null,"href":"/ja/reference"},{"group":"AI","root":{"title":"AI resources","description":null,"href":"/reference/ai-resources"},"pages":[{"title":"AIエージェントのデフォルト構成を取得","openapi":"box-openapi-jp.json GET /ai_agent_default","description":"AIエージェントのデフォルト構成を取得します。","href":"/ja/reference/get-ai-agent-default"},{"title":"質問を送信","openapi":"box-openapi-jp.json POST /ai/ask","description":"サポートされているLLMにAIリクエストを送信し、提供されたコンテキストを考慮してユーザーの質問に特化した回答を返します。\n\n単一のファイル、複数のファイル、またはBox Hubのコンテンツ全体に対して質問できます。Box Hubのコンテンツ全体に対して検索や質問を行うには、`type`を`hubs`、`id`をHubのIDに設定して、単一の項目を送信します。Box AIは、そのHubのすべてのファイルのインデックスが作成されたコンテンツを使用して質問に回答します。\n\nBox Hubについて質問するには、Hubのコンテンツのインデックス作成のため、Hubの作成前に管理コンソールでBox AI for Hubsが有効になっている必要があります。","href":"/ja/reference/post-ai-ask"},{"title":"メタデータを抽出 (自由形式)","openapi":"box-openapi-jp.json POST /ai/extract","description":"サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、メタデータをキー/値ペアの形式で抽出します。このリクエストでは、プロンプトと出力の両方を自由形式にすることができます。リクエストを送信する前に、メタデータテンプレートの設定は必要ありません。","href":"/ja/reference/post-ai-extract"},{"title":"メタデータを抽出 (構造化)","openapi":"box-openapi-jp.json POST /ai/extract_structured","description":"サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、抽出されたメタデータを一連のキー/値ペアとして返します。\n\n抽出の構造を定義するには、メタデータテンプレートまたはフィールドのリストを指定します。テンプレート作成の詳細については、[メタデータテンプレートのカスタマイズ](https://support.box.com/hc/en-us/articles/360044194033-Customizing-Metadata-Templates)を参照するか、[メタデータテンプレートAPI](/guides/metadata/templates/create)を使用してください。\n\nこのエンドポイントは、[抽出エージェント (強化)](/guides/box-ai/ai-tutorials/extract-metadata-structured#enhanced-extract-agent) もサポートしています。\n\nサポートされているファイル形式と言語については、[ファイルからメタデータを抽出する (構造化)](/guides/box-ai/ai-tutorials/extract-metadata-structured) APIガイドを参照してください。","href":"/ja/reference/post-ai-extract-structured"},{"title":"テキストを生成","openapi":"box-openapi-jp.json POST /ai/text_gen","description":"サポートされている大規模言語モデル (LLM) にAIリクエストを送信し、提供されたプロンプトに基づいて生成されたテキストを返します。","href":"/ja/reference/post-ai-text-gen"}]},{"group":"AI Studio","root":{"title":"AI Studio resources","description":null,"href":"/reference/ai-studio-resources"},"pages":[{"title":"エージェントIDを指定してAIエージェントを取得","openapi":"box-openapi-jp.json GET /ai_agents/{agent_id}","description":"`agent_id`パラメータを使用してAIエージェントを取得します。","href":"/ja/reference/get-ai-agents-id"},{"title":"AIエージェントのリストを取得","openapi":"box-openapi-jp.json GET /ai_agents","description":"指定されたパラメータに基づいてAIエージェントのリストを取得します。","href":"/ja/reference/get-ai-agents"},{"title":"AIエージェントを作成","openapi":"box-openapi-jp.json POST /ai_agents","description":"AIエージェントを作成します。`ask`、`text_gen`、`extract`の機能のうち1つ以上を指定する必要があります。","href":"/ja/reference/post-ai-agents"},{"title":"AIエージェントを更新","openapi":"box-openapi-jp.json PUT /ai_agents/{agent_id}","description":"AIエージェントを更新します。","href":"/ja/reference/put-ai-agents-id"},{"title":"AIエージェントを削除","openapi":"box-openapi-jp.json DELETE /ai_agents/{agent_id}","description":"指定されたパラメータを使用してAIエージェントを削除します。","href":"/ja/reference/delete-ai-agents-id"}]},{"group":"アプリ項目の関連付け","root":{"title":"App item associations resources","description":null,"href":"/reference/app-item-associations-resources"},"pages":[{"title":"ファイルのアプリ項目の関連付けのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/app_item_associations","description":"**これはベータ機能のため、利用が制限される可能性があります。**ファイルが関連付けられているアプリ項目をすべて返します。これには、ファイルの先祖に関連付けられているアプリ項目が含まれます。コンテキストユーザーがファイルにアクセスできることを前提に、コンテキストユーザーにアプリ項目の**表示**権限がなくても、種類/IDが示されます。","href":"/ja/reference/get-files-id-app-item-associations"},{"title":"フォルダのアプリ項目の関連付けのリストを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/app_item_associations","description":"**これはベータ機能のため、利用が制限される可能性があります。**フォルダが関連付けられているアプリ項目をすべて返します。これには、フォルダの先祖に関連付けられているアプリ項目が含まれます。コンテキストユーザーがフォルダにアクセスできることを前提に、コンテキストユーザーにアプリ項目の**表示**権限がなくても、種類/IDが示されます。","href":"/ja/reference/get-folders-id-app-item-associations"}]},{"group":"承認","root":{"title":"Authorization resources","description":null,"href":"/reference/authorization-resources"},"pages":[{"title":"ユーザーを承認","openapi":"box-openapi-jp.json GET /authorize","description":"ユーザーを[Box](https://box.com)ウェブサイトにリダイレクトして承認し、ユーザーに代わって操作を実行する権限をリクエストします。\n\nこれは、OAuth 2.0を使用してユーザーを承認する際の最初の手順です。Box APIをユーザーに代わって使用することについて、ユーザーに承認してもらうようリクエストするには、この形式を使用してユーザーを所定のURLにリダイレクトする必要があります。","href":"/ja/reference/get-authorize"},{"title":"アクセストークンを更新","openapi":"box-openapi-jp.json POST /oauth2/token#refresh","description":"クライアントID、シークレット、更新トークンを使用してアクセストークンを更新します。","href":"/ja/reference/post-oauth2-token--refresh"},{"title":"アクセストークンをリクエスト","openapi":"box-openapi-jp.json POST /oauth2/token","description":"クライアント側で取得したOAuth 2.0認証コードまたはサーバー側のJWTアサーションを使用してアクセストークンをリクエストします。\n\nアクセストークンとは、リクエストが認証済みセッションに属していることをBoxで検証するための文字列です。通常の手順では、最初にユーザーが[承認](/reference/get-authorize)エンドポイントに対して認証をリクエストした後で、Boxが認証コードを送信します。\n\nユーザーはこのエンドポイントに認証コードを送信してアクセストークンと交換します。返されたアクセストークンは、Box APIコールを行うときに使用できます。","href":"/ja/reference/post-oauth2-token"},{"title":"アクセストークンを取り消し","openapi":"box-openapi-jp.json POST /oauth2/revoke","description":"アクティブなアクセストークンを無効にします。これにより、認証されていたユーザーはログアウトされます。","href":"/ja/reference/post-oauth2-revoke"}]},{"group":"Box Signリクエスト","root":{"title":"Box Sign requests resources","description":null,"href":"/reference/sign-requests-resources"},"pages":[{"title":"IDを指定してBox Signリクエストを取得","openapi":"box-openapi-jp.json GET /sign_requests/{sign_request_id}","description":"IDを指定して署名リクエストを取得します。","href":"/ja/reference/get-sign-requests-id"},{"title":"Box Signリクエストのリストを取得","openapi":"box-openapi-jp.json GET /sign_requests","description":"ユーザーが作成した署名リクエストを取得します。`sign_files`や`parent_folder`が削除された場合、署名リクエストはリストで返されません。","href":"/ja/reference/get-sign-requests"},{"title":"Box Signリクエストをキャンセル","openapi":"box-openapi-jp.json POST /sign_requests/{sign_request_id}/cancel","description":"署名リクエストをキャンセルします。","href":"/ja/reference/post-sign-requests-id-cancel"},{"title":"Box Signリクエストを作成","openapi":"box-openapi-jp.json POST /sign_requests","description":"署名リクエストを作成します。これには、署名用ドキュメントの準備と署名者への署名リクエストの送信が含まれます。","href":"/ja/reference/post-sign-requests"},{"title":"Box Signリクエストを再送信","openapi":"box-openapi-jp.json POST /sign_requests/{sign_request_id}/resend","description":"未署名の署名者全員に署名リクエストのメールを再送信します。","href":"/ja/reference/post-sign-requests-id-resend"}]},{"group":"Box Signテンプレート","root":{"title":"Box Sign templates resources","description":null,"href":"/reference/sign-templates-resources"},"pages":[{"title":"IDを指定してBox Signテンプレートを取得","openapi":"box-openapi-jp.json GET /sign_templates/{template_id}","description":"特定のBox Signテンプレートの詳細を取得します。","href":"/ja/reference/get-sign-templates-id"},{"title":"Box Signテンプレートのリストを取得","openapi":"box-openapi-jp.json GET /sign_templates","description":"ユーザーによって作成されたBox Signテンプレートを取得します。","href":"/ja/reference/get-sign-templates"}]},{"group":"分類","root":{"title":"Classifications resources","description":null,"href":"/reference/classifications-resources"},"pages":[{"title":"すべての分類のリストを取得","openapi":"box-openapi-jp.json GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema","description":"分類メタデータテンプレートを取得し、この会社が使用できるすべての分類のリストを取得します。\n\nこのAPIは、`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/get-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema"},{"title":"最初の分類を追加","openapi":"box-openapi-jp.json POST /metadata_templates/schema#classifications","description":"会社にまだ分類がない場合は、このAPIコールによって、分類テンプレートが最初の一連の分類で初期化されます。\n\n会社にすでに分類がある場合は、テンプレートがすでに存在するため、さらに分類を追加するためにAPIコールが行われます。","href":"/ja/reference/post-metadata-templates-schema--classifications"},{"title":"分類を追加","openapi":"box-openapi-jp.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add","description":"会社が使用できる分類のリストに1つ以上の新しい分類を追加します。\n\nこのAPIは、`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--add"},{"title":"分類を更新","openapi":"box-openapi-jp.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update","description":"会社が使用できる1つ以上の分類のラベルと説明を更新します。\n\nこのAPIは、`/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/put-metadata-templates-enterprise-securityClassification-6VMVochwUWo-schema--update"}]},{"group":"ファイルの分類","pages":[{"title":"ファイルの分類を取得","openapi":"box-openapi-jp.json GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"ファイルに適用されている分類メタデータインスタンスを取得します。\n\nこのAPIは、`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/get-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"ファイルに分類を追加","openapi":"box-openapi-jp.json POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"追加する分類のラベルを指定することで、ファイルに分類を追加します。\n\nこのAPIは、`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/post-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"ファイルの分類を更新","openapi":"box-openapi-jp.json PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"ファイルの分類を更新します。\n\n分類を更新できるのは、分類がすでにファイルに適用されている場合のみです。分類を編集する際は、会社に対して定義されている値のみを使用できます。","href":"/ja/reference/put-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"ファイルから分類を削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"ファイルからすべての分類を削除します。\n\nこのAPIは、`/files/:id//enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/delete-files-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"フォルダの分類","pages":[{"title":"フォルダの分類を取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"フォルダに適用されている分類メタデータインスタンスを取得します。\n\nこのAPIは、`/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/get-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"フォルダに分類を追加","openapi":"box-openapi-jp.json POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"追加する分類のラベルを指定することで、フォルダに分類を追加します。\n\nこのAPIは、`/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/post-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"フォルダの分類を更新","openapi":"box-openapi-jp.json PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"フォルダの分類を更新します。\n\n分類を更新できるのは、分類がすでにフォルダに適用されている場合のみです。分類を編集する際は、会社に対して定義されている値のみを使用できます。","href":"/ja/reference/put-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"},{"title":"フォルダから分類を削除","openapi":"box-openapi-jp.json DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo","description":"フォルダからすべての分類を削除します。\n\nこのAPIは、`/folders/:id/enterprise_12345/securityClassification-6VMVochwUWo`のように、URLにEnterprise IDを明示的に含めることで呼び出すこともできます。","href":"/ja/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"コラボレーション","root":{"title":"Collaborations resources","description":null,"href":"/reference/user-collaborations-resources"},"pages":[{"title":"コラボレーションを取得","openapi":"box-openapi-jp.json GET /collaborations/{collaboration_id}","description":"1つのコラボレーションを取得します。","href":"/ja/reference/get-collaborations-id"},{"title":"コラボレーションを作成","openapi":"box-openapi-jp.json POST /collaborations","description":"ファイルまたはフォルダに個々のユーザーまたはグループのコラボレーションを追加します。\n\nコラボレーションは、メールアドレス、ユーザーID、またはグループIDを使用して作成できます。\n\nグループを使用してコラボレーションを作成する場合、このエンドポイントにアクセスできるかどうかは、そのグループを招待できるかどうかによって決まります。\n\nコラボレーションが`pending`ステータスの場合、フィールド`name`は以下の条件で編集されます:\n\n- `user_id`を使用してコラボレーションが作成された\n- `login`を使用してコラボレーションが作成された","href":"/ja/reference/post-collaborations"},{"title":"コラボレーションを更新","openapi":"box-openapi-jp.json PUT /collaborations/{collaboration_id}","description":"コラボレーションを更新します。項目の所有者を変更したり、コラボレーションへの招待を承認したりする場合に使用します。コラボレーションへの招待を承認する場合、ロールは必須ではありません。","href":"/ja/reference/put-collaborations-id"},{"title":"コラボレーションを削除","openapi":"box-openapi-jp.json DELETE /collaborations/{collaboration_id}","description":"1つのコラボレーションを削除します。","href":"/ja/reference/delete-collaborations-id"}]},{"group":"コラボレーション (リスト)","pages":[{"title":"ファイルのコラボレーションのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/collaborations","description":"ファイルでの保留中のコラボレーションとアクティブなコラボレーションのリストを取得します。そのファイルに対するアクセス権限を持つか、そのファイルに招待されているすべてのユーザーを返します。","href":"/ja/reference/get-files-id-collaborations"},{"title":"フォルダコラボレーションのリストを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/collaborations","description":"フォルダでの保留中のコラボレーションとアクティブなコラボレーションのリストを取得します。そのフォルダに対するアクセス権限を持つか、そのフォルダに招待されているすべてのユーザーを返します。","href":"/ja/reference/get-folders-id-collaborations"},{"title":"グループコラボレーションのリストを取得","openapi":"box-openapi-jp.json GET /groups/{group_id}/collaborations","description":"グループのすべてのコラボレーションを取得します。会社のグループを調べるには、管理者権限が必要です。\n\nそれぞれのコラボレーションオブジェクトには、そのグループがどのファイルやフォルダにアクセスでき、どのロールが使用されるのかに関する詳細情報が含まれています。","href":"/ja/reference/get-groups-id-collaborations"},{"title":"保留中のコラボレーションのリストを取得","openapi":"box-openapi-jp.json GET /collaborations","description":"このユーザーに関連する保留中のコラボレーション招待をすべて取得します。","href":"/ja/reference/get-collaborations"}]},{"group":"コレクション","root":{"title":"Collections resources","description":null,"href":"/reference/collections-resources"},"pages":[{"title":"IDを指定してコレクションを取得","openapi":"box-openapi-jp.json GET /collections/{collection_id}","description":"IDでコレクションを取得します。","href":"/ja/reference/get-collections-id"},{"title":"すべてのコレクションのリストを取得","openapi":"box-openapi-jp.json GET /collections","description":"指定したユーザーのすべてのコレクションを取得します。\n\n現在サポートされているのは、`favorites`コレクションのみです。","href":"/ja/reference/get-collections"},{"title":"コレクション項目のリストを取得","openapi":"box-openapi-jp.json GET /collections/{collection_id}/items","description":"このコレクションに含まれるファイルやフォルダを取得します。","href":"/ja/reference/get-collections-id-items"}]},{"group":"コメント","root":{"title":"Comments resources","description":null,"href":"/reference/comments-resources"},"pages":[{"title":"コメントを取得","openapi":"box-openapi-jp.json GET /comments/{comment_id}","description":"特定のコメントのメッセージとメタデータに加え、コメントを作成したユーザーに関する情報を取得します。","href":"/ja/reference/get-comments-id"},{"title":"ファイルのコメントのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/comments","description":"ファイルに関するコメントのリストを取得します。","href":"/ja/reference/get-files-id-comments"},{"title":"コメントを作成","openapi":"box-openapi-jp.json POST /comments","description":"ユーザーによるコメントを特定のファイルに追加するか、他のコメントへの返信として追加します。","href":"/ja/reference/post-comments"},{"title":"コメントを更新","openapi":"box-openapi-jp.json PUT /comments/{comment_id}","description":"コメントのメッセージを更新します。","href":"/ja/reference/put-comments-id"},{"title":"コメントを削除","openapi":"box-openapi-jp.json DELETE /comments/{comment_id}","description":"コメントを完全に削除します。","href":"/ja/reference/delete-comments-id"}]},{"group":"Device Pinner","root":{"title":"Device pinners resources","description":null,"href":"/reference/device-pinners-resources"},"pages":[{"title":"デバイスピンを取得","openapi":"box-openapi-jp.json GET /device_pinners/{device_pinner_id}","description":"個々のデバイスピンに関する情報を取得します。","href":"/ja/reference/get-device-pinners-id"},{"title":"会社のデバイスピンのリストを取得","openapi":"box-openapi-jp.json GET /enterprises/{enterprise_id}/device_pinners","description":"会社内のすべてのデバイスピンを取得します。\n\nこの呼び出しを行うにはユーザーに管理者権限が必要で、アプリケーションに「Enterpriseの管理」スコープが必要です。","href":"/ja/reference/get-enterprises-id-device-pinners"},{"title":"デバイスピンを削除","openapi":"box-openapi-jp.json DELETE /device_pinners/{device_pinner_id}","description":"個々のデバイスピンを削除します。","href":"/ja/reference/delete-device-pinners-id"}]},{"group":"ドメインの制限 (ユーザーの除外)","root":{"title":"Domain restrictions (User exemptions) resources","description":null,"href":"/reference/collaboration-allowlist-exempt-targets-resources"},"pages":[{"title":"コラボレーションドメインの制限から除外するユーザーを取得","openapi":"box-openapi-jp.json GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","description":"コラボレーションドメインの制限から除外されているユーザーを返します。","href":"/ja/reference/get-collaboration-whitelist-exempt-targets-id"},{"title":"コラボレーションドメインの制限から除外するユーザーのリストを取得","openapi":"box-openapi-jp.json GET /collaboration_whitelist_exempt_targets","description":"コラボレーションドメインの制限から除外されているユーザーのリストを返します。","href":"/ja/reference/get-collaboration-whitelist-exempt-targets"},{"title":"コラボレーションドメインの制限からのユーザー除外を作成","openapi":"box-openapi-jp.json POST /collaboration_whitelist_exempt_targets","description":"コラボレーションが許可されたドメインリストで設定された制限からユーザーを除外します。","href":"/ja/reference/post-collaboration-whitelist-exempt-targets"},{"title":"ドメインの制限から除外されるユーザーのリストからユーザーを削除","openapi":"box-openapi-jp.json DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}","description":"コラボレーションが許可されたドメインリストで設定された制限からユーザーの除外を削除します。","href":"/ja/reference/delete-collaboration-whitelist-exempt-targets-id"}]},{"group":"コラボレーションのでドメインの制限","root":{"title":"Domain restrictions for collaborations resources","description":null,"href":"/reference/collaboration-allowlist-entries-resources"},"pages":[{"title":"許可されたコラボレーションドメインを取得","openapi":"box-openapi-jp.json GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","description":"現在の会社内でコラボレーションを作成しても安全であると見なされているドメインを返します。","href":"/ja/reference/get-collaboration-whitelist-entries-id"},{"title":"許可されたコラボレーションドメインのリストを取得","openapi":"box-openapi-jp.json GET /collaboration_whitelist_entries","description":"現在の会社内でコラボレーションを作成しても安全であると見なされているドメインのリストを返します。","href":"/ja/reference/get-collaboration-whitelist-entries"},{"title":"許可されたコラボレーションドメインのリストにドメインを追加","openapi":"box-openapi-jp.json POST /collaboration_whitelist_entries","description":"コラボレーションが許可されているドメインのリストに新しいエントリを作成します。","href":"/ja/reference/post-collaboration-whitelist-entries"},{"title":"許可されたコラボレーションドメインのリストからドメインを削除","openapi":"box-openapi-jp.json DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","description":"現在の会社内でコラボレーションを作成しても安全であると見なされているドメインのリストからドメインを削除します。","href":"/ja/reference/delete-collaboration-whitelist-entries-id"}]},{"group":"ダウンロード","pages":[{"title":"ファイルをダウンロード","openapi":"box-openapi-jp.json GET /files/{file_id}/content","description":"ファイルのコンテンツをバイナリ形式で返します。","href":"/ja/reference/get-files-id-content"}]},{"group":"メールエイリアス","root":{"title":"Email aliases resources","description":null,"href":"/reference/email-aliases-resources"},"pages":[{"title":"ユーザーのメールエイリアスのリストを取得","openapi":"box-openapi-jp.json GET /users/{user_id}/email_aliases","description":"ユーザーのすべてのメールエイリアスを取得します。コレクションにユーザーのプライマリログインは含まれません。","href":"/ja/reference/get-users-id-email-aliases"},{"title":"メールエイリアスを作成","openapi":"box-openapi-jp.json POST /users/{user_id}/email_aliases","description":"新しいメールエイリアスをユーザーアカウントに追加します。","href":"/ja/reference/post-users-id-email-aliases"},{"title":"メールエイリアスを削除","openapi":"box-openapi-jp.json DELETE /users/{user_id}/email_aliases/{email_alias_id}","description":"ユーザーからメールエイリアスを削除します。","href":"/ja/reference/delete-users-id-email-aliases-id"}]},{"group":"イベント","root":{"title":"Events resources","description":null,"href":"/reference/events-resources"},"pages":[{"title":"User EventおよびEnterprise Eventのリストを取得","openapi":"box-openapi-jp.json GET /events","description":"指定したユーザーまたは会社全体の過去のイベントを最大1年間遡って返します。\n\nデフォルトでは、認証済みユーザーのイベントが返されます。Enterprise全体のイベントを取得するには、`stream_type`を`admin_logs_streaming`に設定して新しいイベントをライブで監視するか、`admin_logs`に設定してイベントの履歴を照会します。このAPIコールを行うユーザーは管理者権限を所有していること、アプリケーションでは`manage enterprise properties`スコープが確認されていることが必要になります。","href":"/ja/reference/get-events"},{"title":"イベントのLong pollingエンドポイントを取得","openapi":"/box-openapi-jp.json OPTIONS /events","description":null,"href":"/ja/reference/options-events"}]},{"group":"ファイルリクエスト","root":{"title":"File requests resources","description":null,"href":"/reference/file-requests-resources"},"pages":[{"title":"ファイルリクエストを取得","openapi":"box-openapi-jp.json GET /file_requests/{file_request_id}","description":"ファイルリクエストに関する情報を取得します。","href":"/ja/reference/get-file-requests-id"},{"title":"ファイルリクエストをコピー","openapi":"box-openapi-jp.json POST /file_requests/{file_request_id}/copy","description":"あるフォルダにすでに存在する既存のファイルリクエストをコピーし、別のフォルダに適用します。","href":"/ja/reference/post-file-requests-id-copy"},{"title":"ファイルリクエストを更新","openapi":"box-openapi-jp.json PUT /file_requests/{file_request_id}","description":"ファイルリクエストを更新します。これは使用すると、ファイルリクエストを有効化または無効化できます。","href":"/ja/reference/put-file-requests-id"},{"title":"ファイルリクエストを削除","openapi":"box-openapi-jp.json DELETE /file_requests/{file_request_id}","description":"ファイルリクエストを完全に削除します。","href":"/ja/reference/delete-file-requests-id"}]},{"group":"ファイルバージョンリーガルホールド","root":{"title":"File version legal holds resources","description":null,"href":"/reference/file-version-legal-holds-resources"},"pages":[{"title":"ファイルバージョンリーガルホールドを取得","openapi":"box-openapi-jp.json GET /file_version_legal_holds/{file_version_legal_hold_id}","description":"ファイルバージョンに割り当てられているリーガルホールドポリシーに関する情報を取得します。","href":"/ja/reference/get-file-version-legal-holds-id"},{"title":"ファイルバージョンリーガルホールドのリストを取得","openapi":"box-openapi-jp.json GET /file_version_legal_holds","description":"リーガルホールド割り当てに関する、リーガルホールドのファイルバージョンのリストを取得します。\n\n進行中の再構築作業により、このAPIでは、このポリシーIDのファイルバージョンがすべて返されるとは限りません。\n\n代わりに、このAPIで返されるのは、従来のアーキテクチャで保持されているファイルバージョンのみです。新しいアーキテクチャで保持されているすべてのファイルバージョンをリクエストするために2つの新しいエンドポイントが使用可能になります。\n\n新しいアーキテクチャで保持されるファイルバージョンについては、`GET /legal_hold_policy_assignments/:id/file_versions_on_hold` APIを使用すると、このポリシー割り当てに使用できる過去のファイルバージョンをすべて返すことができます。また、`GET /legal_hold_policy_assignments/:id/files_on_hold` APIを使用すると、リーガルホールドの対象となるファイルの現在 (最新) バージョンを返すこともできます。\n\n`GET /legal_hold_policy_assignments?policy_id={id}` APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。\n\n再構築が完了すると、このAPIは非推奨になります。","href":"/ja/reference/get-file-version-legal-holds"}]},{"group":"ファイルバージョンリテンション","root":{"title":"File version retentions resources","description":null,"href":"/reference/file-version-retentions-resources"},"pages":[{"title":"ファイルのリテンションを取得","openapi":"box-openapi-jp.json GET /file_version_retentions/{file_version_retention_id}","description":"ファイルバージョンリテンションに関する情報を返します。\n\n**注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](/reference/get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](/reference/get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。","href":"/ja/reference/get-file-version-retentions-id"},{"title":"ファイルバージョンリテンションのリストを取得","openapi":"box-openapi-jp.json GET /file_version_retentions","description":"指定した会社のすべてのファイルバージョンリテンションを取得します。\n\n**注**: ファイルリテンションAPIは**非推奨**になりました。リテンションの対象となるファイルおよびファイルバージョンに関する情報を取得するには、[リテンションの対象となるファイル](/reference/get-retention-policy-assignments-id-files-under-retention)または[リテンションの対象となるファイルバージョン](/reference/get-retention-policy-assignments-id-file-versions-under-retention)のエンドポイントを参照してください。","href":"/ja/reference/get-file-version-retentions"}]},{"group":"ファイルバージョン","root":{"title":"File versions resources","description":null,"href":"/reference/file-versions-resources"},"pages":[{"title":"ファイルバージョンを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/versions/{file_version_id}","description":"特定のファイルバージョンを取得します。\n\nバージョンが追跡されるのは、プレミアムアカウントを持つBoxユーザーのファイルに関してのみです。","href":"/ja/reference/get-files-id-versions-id"},{"title":"すべてのファイルバージョンのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/versions","description":"ファイルの過去のバージョンのリストを取得します。\n\nバージョンを追跡するのは、プレミアム (有償) アカウントを持つBoxユーザーのみです。ファイルの現在のバージョンのIDを取得するには、`GET /file/:id` APIを使用します。","href":"/ja/reference/get-files-id-versions"},{"title":"ファイルバージョンを昇格","openapi":"box-openapi-jp.json POST /files/{file_id}/versions/current","description":"特定のファイルバージョンを昇格させます。\n\n以前のバージョンが存在する場合は、この方法を使用して古いバージョンのいずれかをバージョン履歴の先頭に移動できます。\n\nこれにより、古いバージョンの新しいコピーが作成されて、バージョン履歴の先頭に配置されます。このファイルは古いバージョンとまったく同じ内容になり、ハッシュダイジェスト、`etag`、およびファイル名も同じになります。\n\nコメントなど、他のプロパティが以前の値に更新されることはありません。\n\nこのエンドポイントは、PDF、DOC、PPTXなどのファイル形式で機能するため、Box Notesの復元には使用しないでください。","href":"/ja/reference/post-files-id-versions-current"},{"title":"ファイルバージョンを復元","openapi":"box-openapi-jp.json PUT /files/{file_id}/versions/{file_version_id}","description":"削除された、ファイルの特定のバージョンを復元します。このエンドポイントは、PDF、DOC、PPTXなどのファイル形式で機能するため、Box Notesの復元には使用しないでください。","href":"/ja/reference/put-files-id-versions-id"},{"title":"ファイルバージョンを削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}/versions/{file_version_id}","description":"特定のファイルバージョンをごみ箱に移動します。\n\nバージョンが追跡されるのは、プレミアムアカウントを持つBoxユーザーのファイルに関してのみです。","href":"/ja/reference/delete-files-id-versions-id"}]},{"group":"ファイル","root":{"title":"Files resources","description":null,"href":"/reference/files-resources"},"pages":[{"title":"ファイル情報を取得","openapi":"box-openapi-jp.json GET /files/{file_id}","description":"ファイルに関する詳細を取得します。","href":"/ja/reference/get-files-id"},{"title":"ファイルサムネイルを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/thumbnail.{extension}","description":"ファイルのサムネイル (小さい画像レプリゼンテーション) を取得します。\n\nサイズ`32x32`、`64x64`、`128x128`、`256x256`は`.png`形式で返すことができます。また、サイズ`32x32`、`160x160`、`320x320`は`.jpg`形式で返すことができます。\n\nサムネイルを生成できる画像および動画ファイルの形式については、[こちら][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":"/ja/reference/get-files-id-thumbnail-id"},{"title":"ファイルをコピー","openapi":"box-openapi-jp.json POST /files/{file_id}/copy","description":"ファイルのコピーを作成します。","href":"/ja/reference/post-files-id-copy"},{"title":"ファイルを更新","openapi":"box-openapi-jp.json PUT /files/{file_id}","description":"ファイルを更新します。ファイルの名前変更や移動、共有リンクの作成、ファイルのロックといった目的に使用できます。","href":"/ja/reference/put-files-id"},{"title":"ファイルを削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}","description":"ファイルを削除します (完全に削除するか、ごみ箱に移動します)。\n\n項目がBoxから完全に削除されるか、ごみ箱に移動されるかは、会社の設定により決定されます。","href":"/ja/reference/delete-files-id"}]},{"group":"フォルダロック","root":{"title":"Folder Locks resources","description":null,"href":"/reference/folder-locks-resources"},"pages":[{"title":"フォルダロックのリストを取得","openapi":"box-openapi-jp.json GET /folder_locks","description":"指定したフォルダのフォルダロックの詳細を取得します。\n\nこのエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。","href":"/ja/reference/get-folder-locks"},{"title":"フォルダロックを作成","openapi":"box-openapi-jp.json POST /folder_locks","description":"フォルダにフォルダロックを作成し、フォルダが移動または削除されないようにします。\n\nこのエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。","href":"/ja/reference/post-folder-locks"},{"title":"フォルダロックを削除","openapi":"box-openapi-jp.json DELETE /folder_locks/{folder_lock_id}","description":"指定したフォルダに適用されているフォルダロックを削除します。\n\nこのエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。","href":"/ja/reference/delete-folder-locks-id"}]},{"group":"フォルダ","root":{"title":"Folders resources","description":null,"href":"/reference/folders-resources"},"pages":[{"title":"フォルダ情報を取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}","description":"フォルダ内の最初の100エントリを含むフォルダの詳細を取得します。\n\nクエリで`sort`、`direction`、`offset`、および`limit`パラメータを渡すと、返される[フォルダ項目](/reference/resources/folder--full#param-item-collection)のリストを管理できます。\n\nフォルダ内の項目をさらに取得するには、[フォルダ内の項目を取得](/reference/get-folders-id-items)エンドポイントを使用します。","href":"/ja/reference/get-folders-id"},{"title":"フォルダ内の項目のリストを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/items","description":"フォルダ内の項目のページを取得します。これらの項目はファイル、 フォルダ、ウェブリンクのいずれかになります。\n\nフォルダ自体の詳細情報 (サイズなど) をリクエストするには、代わりに[フォルダを取得](/reference/get-folders-id)エンドポイントを使用します。","href":"/ja/reference/get-folders-id-items"},{"title":"フォルダをコピー","openapi":"box-openapi-jp.json POST /folders/{folder_id}/copy","description":"フォルダのコピーを宛先フォルダ内に作成します。\n\n元のフォルダは変更されません。","href":"/ja/reference/post-folders-id-copy"},{"title":"フォルダを作成","openapi":"box-openapi-jp.json POST /folders","description":"指定した親フォルダ内に空のフォルダを新規に作成します。","href":"/ja/reference/post-folders"},{"title":"フォルダを更新","openapi":"box-openapi-jp.json PUT /folders/{folder_id}","description":"フォルダを更新します。フォルダの移動、共有リンクの作成、コラボレーションの更新といった目的にも使用できます。","href":"/ja/reference/put-folders-id"},{"title":"フォルダを削除","openapi":"box-openapi-jp.json DELETE /folders/{folder_id}","description":"フォルダを完全に削除するか、ごみ箱に移動して削除します。","href":"/ja/reference/delete-folders-id"}]},{"group":"グループメンバーシップ","root":{"title":"Group memberships resources","description":null,"href":"/reference/memberships-resources"},"pages":[{"title":"グループメンバーシップを取得","openapi":"box-openapi-jp.json GET /group_memberships/{group_membership_id}","description":"特定のグループメンバーシップを取得します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/get-group-memberships-id"},{"title":"グループのメンバーのリストを取得","openapi":"box-openapi-jp.json GET /groups/{group_id}/memberships","description":"グループのすべてのユーザーを取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/get-groups-id-memberships"},{"title":"ユーザーのグループのリストを取得","openapi":"box-openapi-jp.json GET /users/{user_id}/memberships","description":"ユーザーのすべてのグループを取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/get-users-id-memberships"},{"title":"ユーザーをグループに追加","openapi":"box-openapi-jp.json POST /group_memberships","description":"グループメンバーシップを作成します。管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/post-group-memberships"},{"title":"グループメンバーシップを更新","openapi":"box-openapi-jp.json PUT /group_memberships/{group_membership_id}","description":"ユーザーのグループメンバーシップを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/put-group-memberships-id"},{"title":"ユーザーをグループから削除","openapi":"box-openapi-jp.json DELETE /group_memberships/{group_membership_id}","description":"特定のグループメンバーシップを削除します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/delete-group-memberships-id"}]},{"group":"グループ","root":{"title":"Groups resources","description":null,"href":"/reference/groups-resources"},"pages":[{"title":"グループを取得","openapi":"box-openapi-jp.json GET /groups/{group_id}","description":"グループに関する情報を取得します。このグループのメンバー、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/get-groups-id"},{"title":"会社のグループのリストを取得","openapi":"box-openapi-jp.json GET /groups","description":"指定した会社のすべてのグループを取得します。会社のグループを調べるには、管理者権限が必要です。","href":"/ja/reference/get-groups"},{"title":"グループを作成","openapi":"box-openapi-jp.json POST /groups","description":"会社内に新しいユーザーグループを作成します。新しいグループを作成できるのは、管理者権限を持つユーザーのみです。","href":"/ja/reference/post-groups"},{"title":"グループを更新","openapi":"box-openapi-jp.json PUT /groups/{group_id}","description":"特定のグループを更新します。このグループの管理者、または管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/put-groups-id"},{"title":"グループを削除","openapi":"box-openapi-jp.json DELETE /groups/{group_id}","description":"グループを完全に削除します。管理者レベルの権限を持つユーザーのみがこのAPIを使用できます。","href":"/ja/reference/delete-groups-id"}]},{"group":"統合マッピング","root":{"title":"Integration mappings resources","description":null,"href":"/reference/integration-mappings-resources"},"pages":[{"title":"Slack統合マッピングのリストを取得","openapi":"box-openapi-jp.json GET /integration_mappings/slack","description":"ユーザーの企業内の[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)のリストを取得します。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/get-integration-mappings-slack"},{"title":"Teams統合マッピングのリストを取得","openapi":"box-openapi-jp.json GET /integration_mappings/teams","description":"ユーザーの企業内の[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)のリストを取得します。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/get-integration-mappings-teams"},{"title":"Slack統合マッピングを作成","openapi":"box-openapi-jp.json POST /integration_mappings/slack","description":"SlackチャンネルをBox項目にマッピングすることで、[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)を作成します。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/post-integration-mappings-slack"},{"title":"Teams統合マッピングを作成","openapi":"box-openapi-jp.json POST /integration_mappings/teams","description":"TeamsチャネルをBox項目にマッピングすることで、[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)を作成します。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/post-integration-mappings-teams"},{"title":"Slack統合マッピングを更新","openapi":"box-openapi-jp.json PUT /integration_mappings/slack/{integration_mapping_id}","description":"[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)を更新します。BoxフォルダIDおよびオプションの更新をサポートします。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/put-integration-mappings-slack-id"},{"title":"Teams統合マッピングを更新","openapi":"box-openapi-jp.json PUT /integration_mappings/teams/{integration_mapping_id}","description":"[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)を更新します。BoxフォルダIDおよびオプションの更新をサポートします。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/put-integration-mappings-teams-id"},{"title":"Slack統合マッピングを削除","openapi":"box-openapi-jp.json DELETE /integration_mappings/slack/{integration_mapping_id}","description":"[Slack統合マッピング](https://support.box.com/hc/en-us/articles/4415585987859-Box-as-the-Content-Layer-for-Slack)を削除します。\n\nこのエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/delete-integration-mappings-slack-id"},{"title":"Teams統合マッピングを削除","openapi":"box-openapi-jp.json DELETE /integration_mappings/teams/{integration_mapping_id}","description":"[Teams統合マッピング](https://support.box.com/hc/en-us/articles/360044681474-Using-Box-for-Teams)を削除します。このエンドポイントを使用するには、管理者または共同管理者の役割が必要です。","href":"/ja/reference/delete-integration-mappings-teams-id"}]},{"group":"招待","root":{"title":"Invites resources","description":null,"href":"/reference/invites-resources"},"pages":[{"title":"ユーザー招待ステータスを取得","openapi":"box-openapi-jp.json GET /invites/{invite_id}","description":"ユーザー招待のステータスを返します。","href":"/ja/reference/get-invites-id"},{"title":"ユーザー招待を作成","openapi":"box-openapi-jp.json POST /invites","description":"既存の外部ユーザーを会社に招待します。\n\nすでに他の会社に所属しているユーザーや、Boxアカウントを持たないユーザーを招待することはできません。招待されたユーザーには、Boxウェブアプリケーションで招待を承認するように促すメールが届きます。\n\nこの方法を使用する場合は、対象アプリケーションに対して「Enterpriseの管理」スコープを有効にする必要があります。これは、開発者コンソールから有効にできます。","href":"/ja/reference/post-invites"}]},{"group":"リーガルホールドポリシー","root":{"title":"Legal hold policies resources","description":null,"href":"/reference/legal-hold-policies-resources"},"pages":[{"title":"リーガルホールドポリシーを取得","openapi":"box-openapi-jp.json GET /legal_hold_policies/{legal_hold_policy_id}","description":"リーガルホールドポリシーを取得します。","href":"/ja/reference/get-legal-hold-policies-id"},{"title":"すべてのリーガルホールドポリシーのリストを取得","openapi":"box-openapi-jp.json GET /legal_hold_policies","description":"会社に属するリーガルホールドポリシーのリストを取得します。","href":"/ja/reference/get-legal-hold-policies"},{"title":"リーガルホールドポリシーを作成","openapi":"box-openapi-jp.json POST /legal_hold_policies","description":"新しいリーガルホールドポリシーを作成します。","href":"/ja/reference/post-legal-hold-policies"},{"title":"リーガルホールドポリシーを更新","openapi":"box-openapi-jp.json PUT /legal_hold_policies/{legal_hold_policy_id}","description":"リーガルホールドポリシーを更新します。","href":"/ja/reference/put-legal-hold-policies-id"},{"title":"リーガルホールドポリシーを削除","openapi":"box-openapi-jp.json DELETE /legal_hold_policies/{legal_hold_policy_id}","description":"既存のリーガルホールドポリシーを削除します。\n\nこれは非同期的プロセスです。レスポンスの返された時点では、ポリシーはまだ完全には削除されていません。","href":"/ja/reference/delete-legal-hold-policies-id"}]},{"group":"リーガルホールドポリシー割り当て","root":{"title":"Legal hold policy assignments resources","description":null,"href":"/reference/legal-hold-policy-assignments-resources"},"pages":[{"title":"リーガルホールドポリシー割り当てを取得","openapi":"box-openapi-jp.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","description":"リーガルホールドポリシー割り当てを取得します。","href":"/ja/reference/get-legal-hold-policy-assignments-id"},{"title":"リーガルホールドポリシー割り当てに関する現在のファイルバージョンを含むファイルのリストを取得","openapi":"box-openapi-jp.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/files_on_hold","description":"リーガルホールド割り当てに関する現在のファイルバージョンを含むファイルのリストを取得します。\n\n場合によっては、代わりに以前のファイルバージョンを取得できます。このような場合は、代わりに`GET /legal_hold_policy_assignments/:id/file_versions_on_hold` APIを使用すると、このリーガルホールドポリシー割り当てに関するファイルの以前のバージョンが返されます。\n\n進行中の再構築作業により、このAPIでは、このポリシーID用に保持されているすべてのファイルバージョンが返されない場合があります。代わりに、このAPIで返されるのは、新しく開発されたアーキテクチャで保持されている最新のファイルバージョンのみです。`GET /file_version_legal_holds` APIを使用すると、従来のアーキテクチャ内で保持されているファイルの現在のバージョンと過去のバージョンを取得できます。\n\nこのエンドポイントは、カストディアンがHubでコラボレーションしているためにリーガルホールドが設定されているコンテンツを返すことをサポートしていません。\n\n`GET /legal_hold_policy_assignments?policy_id={id}` APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。","href":"/ja/reference/get-legal-hold-policy-assignments-id-files-on-hold"},{"title":"リーガルホールドポリシー割り当てのリストを取得","openapi":"box-openapi-jp.json GET /legal_hold_policy_assignments","description":"リーガルホールドポリシーが割り当てられている項目のリストを取得します。","href":"/ja/reference/get-legal-hold-policy-assignments"},{"title":"リーガルホールドポリシー割り当てに関する以前のファイルバージョンのリストを取得","openapi":"box-openapi-jp.json GET /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}/file_versions_on_hold","description":"リーガルホールド割り当てに関する以前のファイルバージョンのリストを取得します。\n\n場合によっては、代わりに最新のファイルバージョンのみが必要になることもあります。このような場合は、代わりに`GET /legal_hold_policy_assignments/:id/files_on_hold` APIを使用すると、このリーガルホールドポリシー割り当てに関するファイルの現在 (最新) のバージョンが返されます。\n\n進行中の再構築作業により、このAPIでは、このポリシーIDの保持されているファイルがすべて返されるとは限りません。代わりに、このAPIで返されるのは、新しく開発されたアーキテクチャで保持されている過去のファイルバージョンのみです。`GET /file_version_legal_holds` APIを使用すると、従来のアーキテクチャ内で保持されているファイルの現在のバージョンと過去のバージョンを取得できます。\n\nこのエンドポイントは、カストディアンがHubでコラボレーションしているためにリーガルホールドが設定されているコンテンツを返すことをサポートしていません。\n\n`GET /legal_hold_policy_assignments?policy_id={id}` APIを使用すると、指定したポリシーIDのポリシー割り当てのリストを確認できます。","href":"/ja/reference/get-legal-hold-policy-assignments-id-file-versions-on-hold"},{"title":"リーガルホールドポリシーを割り当て","openapi":"box-openapi-jp.json POST /legal_hold_policy_assignments","description":"file、file_version、folder、user、ownership、またはinteractionsの項目タイプにリーガルホールドを割り当てます。","href":"/ja/reference/post-legal-hold-policy-assignments"},{"title":"リーガルホールドポリシーの割り当てを解除","openapi":"box-openapi-jp.json DELETE /legal_hold_policy_assignments/{legal_hold_policy_assignment_id}","description":"項目からリーガルホールドを削除します。\n\nこれは非同期的プロセスです。レスポンスが返された時点では、ポリシーはまだ完全には削除されていません。","href":"/ja/reference/delete-legal-hold-policy-assignments-id"}]},{"group":"メタデータカスケードポリシー","root":{"title":"Metadata cascade policies resources","description":null,"href":"/reference/metadata-cascade-policies-resources"},"pages":[{"title":"メタデータカスケードポリシーを取得","openapi":"box-openapi-jp.json GET /metadata_cascade_policies/{metadata_cascade_policy_id}","description":"フォルダに割り当てられた特定のメタデータカスケードポリシーを取得します。","href":"/ja/reference/get-metadata-cascade-policies-id"},{"title":"メタデータカスケードポリシーのリストを取得","openapi":"box-openapi-jp.json GET /metadata_cascade_policies","description":"指定したフォルダに適用されているすべてのメタデータカスケードポリシーのリストを取得します。これは、IDが`0`のルートフォルダでは使用できません。","href":"/ja/reference/get-metadata-cascade-policies"},{"title":"メタデータカスケードポリシーを作成","openapi":"box-openapi-jp.json POST /metadata_cascade_policies","description":"指定したメタデータテンプレートを指定したフォルダに適用し、そのフォルダ内のすべてのファイルに自動的にカスケードする新しいメタデータカスケードポリシーを作成します。\n\nポリシーを適用するには、まず、ポリシーの適用先となるフォルダにメタデータインスタンスを適用する必要があります。","href":"/ja/reference/post-metadata-cascade-policies"},{"title":"フォルダにメタデータカスケードポリシーを強制適用","openapi":"box-openapi-jp.json POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply","description":"メタデータカスケードポリシーを持つフォルダのメタデータをそのすべての子に強制的に適用します。これは、新しいカスケードポリシーの作成後、そのフォルダ内にある既存のすべてのファイルにカスケードされるメタデータを適用するのに使用できます。","href":"/ja/reference/post-metadata-cascade-policies-id-apply"},{"title":"メタデータカスケードポリシーを削除","openapi":"box-openapi-jp.json DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}","description":"メタデータカスケードポリシーを削除します。","href":"/ja/reference/delete-metadata-cascade-policies-id"}]},{"group":"メタデータインスタンス (ファイル)","root":{"title":"Metadata instances (Files) resources","description":null,"href":"/reference/file-metadata-resources"},"pages":[{"title":"ファイルのメタデータインスタンスを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/metadata/{scope}/{template_key}","description":"ファイルに適用されたメタデータテンプレートのインスタンスを取得します。","href":"/ja/reference/get-files-id-metadata-id-id"},{"title":"ファイルのメタデータインスタンスのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/metadata","description":"指定したファイルのすべてのメタデータを取得します。","href":"/ja/reference/get-files-id-metadata"},{"title":"ファイルにメタデータインスタンスを作成","openapi":"box-openapi-jp.json POST /files/{file_id}/metadata/{scope}/{template_key}","description":"メタデータテンプレートのインスタンスをファイルに適用します。\n\nほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できる`global.properties`テンプレートは除きます。","href":"/ja/reference/post-files-id-metadata-id-id"},{"title":"ファイルのメタデータインスタンスを更新","openapi":"box-openapi-jp.json PUT /files/{file_id}/metadata/{scope}/{template_key}","description":"ファイルのメタデータを更新します。\n\nメタデータインスタンスを更新できるのは、テンプレートがすでにファイルに適用されている場合のみです。メタデータを編集する際には、メタデータテンプレートのスキーマに一致した値のみを使用できます。\n\n更新はアトミックに適用されます。操作の適用中にエラーが発生した場合、メタデータインスタンスは変更されません。","href":"/ja/reference/put-files-id-metadata-id-id"},{"title":"ファイルからメタデータインスタンスを削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}/metadata/{scope}/{template_key}","description":"ファイルメタデータを削除します。","href":"/ja/reference/delete-files-id-metadata-id-id"}]},{"group":"メタデータインスタンス (フォルダ)","pages":[{"title":"フォルダのメタデータインスタンスを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/metadata/{scope}/{template_key}","description":"フォルダに適用されているメタデータテンプレートのインスタンスを取得します。これは、IDが`0`のルートフォルダでは使用できません。","href":"/ja/reference/get-folders-id-metadata-id-id"},{"title":"フォルダのメタデータインスタンスのリストを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/metadata","description":"指定したフォルダのすべてのメタデータを取得します。これは、IDが`0`のルートフォルダでは使用できません。","href":"/ja/reference/get-folders-id-metadata"},{"title":"フォルダにメタデータインスタンスを作成","openapi":"box-openapi-jp.json POST /folders/{folder_id}/metadata/{scope}/{template_key}","description":"メタデータテンプレートのインスタンスをフォルダに適用します。\n\nほとんどの場合、メタデータテンプレートに存在する値のみを使用できます。ただし、任意のキー/値ペアを使用できる`global.properties`テンプレートは除きます。\n\nBoxウェブアプリでメタデータテンプレートを表示するために、企業では、管理コンソールでユーザーの \\[**フォルダレベルメタデータのカスケード**] を有効にするよう設定する必要があります。","href":"/ja/reference/post-folders-id-metadata-id-id"},{"title":"フォルダのメタデータインスタンスを更新","openapi":"box-openapi-jp.json PUT /folders/{folder_id}/metadata/{scope}/{template_key}","description":"フォルダのメタデータを更新します。\n\nメタデータインスタンスを更新できるのは、テンプレートがすでにフォルダに適用されている場合のみです。メタデータを編集する際には、メタデータテンプレートのスキーマに一致した値のみを使用できます。\n\n更新はアトミックに適用されます。操作の適用中にエラーが発生した場合、メタデータインスタンスは変更されません。","href":"/ja/reference/put-folders-id-metadata-id-id"},{"title":"フォルダからメタデータインスタンスを削除","openapi":"box-openapi-jp.json DELETE /folders/{folder_id}/metadata/{scope}/{template_key}","description":"フォルダメタデータを削除します。","href":"/ja/reference/delete-folders-id-metadata-id-id"}]},{"group":"メタデータ階層","root":{"title":"Metadata taxonomies resources","description":null,"href":"/reference/metadata-taxonomies-resources"},"pages":[{"title":"名前空間のメタデータ階層を取得","openapi":"box-openapi-jp.json GET /metadata_taxonomies/{namespace}","description":"名前空間のメタデータ階層をすべて取得する場合に使用します。","href":"/ja/reference/get-metadata-taxonomies-id"},{"title":"メタデータ階層キーを指定してメタデータ階層を取得","openapi":"box-openapi-jp.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}","description":"メタデータ階層キーを指定してメタデータ階層を取得する場合に使用します。","href":"/ja/reference/get-metadata-taxonomies-id-id"},{"title":"IDを指定してメタデータ階層ノードを取得","openapi":"box-openapi-jp.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","description":"識別子を指定してメタデータ階層ノードを取得します。","href":"/ja/reference/get-metadata-taxonomies-id-id-nodes-id"},{"title":"メタデータ階層ノードのリストを取得","openapi":"box-openapi-jp.json GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","description":"指定したパラメータに基づいてメタデータ階層ノードを取得する場合に使用します。`query`パラメータを渡さない限り、結果は辞書式順序に並べ替えられます。`query`パラメータを指定すると、結果は関連度順で並べ替えられます。","href":"/ja/reference/get-metadata-taxonomies-id-id-nodes"},{"title":"メタデータテンプレートのメタデータ階層フィールドオプションのリストを取得","openapi":"box-openapi-jp.json GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options","description":"メタデータ階層フィールドの構成および指定したパラメータに基づいて、そのフィールドで使用可能なメタデータ階層ノードを取得する場合に使用します。`query`パラメータを渡さない限り、結果は辞書式順序に並べ替えられます。`query`パラメータを指定すると、結果は関連度順で並べ替えられます。","href":"/ja/reference/get-metadata-templates-id-id-fields-id-options"},{"title":"メタデータ階層レベルを追加","openapi":"box-openapi-jp.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append","description":"新しいメタデータ階層レベルを作成し、既存のレベルに追加します。定義されているレベルがない場合は、第1レベルを作成します。","href":"/ja/reference/post-metadata-taxonomies-id-id-levels--append"},{"title":"メタデータ階層を作成","openapi":"box-openapi-jp.json POST /metadata_taxonomies","description":"メタデータテンプレートで使用可能な新しいメタデータ階層を作成します。","href":"/ja/reference/post-metadata-taxonomies"},{"title":"メタデータ階層レベルを作成","openapi":"box-openapi-jp.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels","description":"新しいメタデータ階層レベルを作成します。","href":"/ja/reference/post-metadata-taxonomies-id-id-levels"},{"title":"メタデータ階層ノードを作成","openapi":"box-openapi-jp.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes","description":"新しいメタデータ階層ノードを作成します。","href":"/ja/reference/post-metadata-taxonomies-id-id-nodes"},{"title":"メタデータ階層レベルを削除","openapi":"box-openapi-jp.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim","description":"最後のレベルのメタデータ階層を削除します。","href":"/ja/reference/post-metadata-taxonomies-id-id-levels--trim"},{"title":"メタデータ階層を更新","openapi":"box-openapi-jp.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}","description":"既存のメタデータ階層を更新します。","href":"/ja/reference/patch-metadata-taxonomies-id-id"},{"title":"メタデータ階層レベルを更新","openapi":"box-openapi-jp.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}","description":"既存のメタデータ階層レベルを更新します。","href":"/ja/reference/patch-metadata-taxonomies-id-id-levels-id"},{"title":"メタデータ階層ノードを更新","openapi":"box-openapi-jp.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","description":"既存のメタデータ階層ノードを更新します。","href":"/ja/reference/patch-metadata-taxonomies-id-id-nodes-id"},{"title":"メタデータ階層を削除","openapi":"box-openapi-jp.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}","description":"メタデータ階層を削除します。これは完全削除であり、元に戻すことはできません。","href":"/ja/reference/delete-metadata-taxonomies-id-id"},{"title":"メタデータ階層ノードを削除","openapi":"box-openapi-jp.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}","description":"メタデータ階層ノードを削除します。これは完全削除であり、元に戻すことはできません。削除できるのは、子を持たないメタデータ階層ノードのみです。","href":"/ja/reference/delete-metadata-taxonomies-id-id-nodes-id"}]},{"group":"メタデータテンプレート","root":{"title":"Metadata templates resources","description":null,"href":"/reference/metadata-templates-resources"},"pages":[{"title":"インスタンスIDでメタデータテンプレートを検索","openapi":"box-openapi-jp.json GET /metadata_templates","description":"テンプレートのインスタンスのIDを検索することにより、メタデータテンプレートを見つけます。","href":"/ja/reference/get-metadata-templates"},{"title":"IDを指定してメタデータテンプレートを取得","openapi":"box-openapi-jp.json GET /metadata_templates/{template_id}","description":"IDを指定してメタデータテンプレートを取得します。","href":"/ja/reference/get-metadata-templates-id"},{"title":"名前を指定してメタデータテンプレートを取得","openapi":"box-openapi-jp.json GET /metadata_templates/{scope}/{template_key}/schema","description":"`scope`と`templateKey`の値でメタデータテンプレートを取得します。\n\nテンプレートの`scope`と`templateKey`を調べるには、会社のすべてのテンプレートまたはグローバルテンプレートのリストを取得するか、ファイルまたはフォルダに適用されているすべてのテンプレートのリストを取得します。","href":"/ja/reference/get-metadata-templates-id-id-schema"},{"title":"すべてのグローバルメタデータテンプレートのリストを取得","openapi":"box-openapi-jp.json GET /metadata_templates/global","description":"Boxを使用するすべての会社が利用できる、すべての汎用グローバルメタデータテンプレートを取得する場合に使用します。","href":"/ja/reference/get-metadata-templates-global"},{"title":"企業のすべてのメタデータテンプレートのリストを取得","openapi":"box-openapi-jp.json GET /metadata_templates/enterprise","description":"特にユーザーの企業内で使用するために作成されたメタデータテンプレートをすべて取得する場合に使用します。","href":"/ja/reference/get-metadata-templates-enterprise"},{"title":"メタデータテンプレートを作成","openapi":"box-openapi-jp.json POST /metadata_templates/schema","description":"ファイルやフォルダに適用可能な新しいメタデータテンプレートを作成します。","href":"/ja/reference/post-metadata-templates-schema"},{"title":"メタデータテンプレートを更新","openapi":"box-openapi-jp.json PUT /metadata_templates/{scope}/{template_key}/schema","description":"メタデータテンプレートを更新します。\n\nメタデータテンプレートを更新できるのは、テンプレートがすでに存在する場合のみです。\n\n更新はアトミックに適用されます。操作の適用中にエラー場が発生した場合、メタデータテンプレートは変更されません。","href":"/ja/reference/put-metadata-templates-id-id-schema"},{"title":"メタデータテンプレートを削除","openapi":"box-openapi-jp.json DELETE /metadata_templates/{scope}/{template_key}/schema","description":"メタデータテンプレートとそのインスタンスを削除します。これは完全削除であり、元に戻すことはできません。","href":"/ja/reference/delete-metadata-templates-id-id-schema"}]},{"group":"最近使用した項目","root":{"title":"Recent items resources","description":null,"href":"/reference/recent-items-resources"},"pages":[{"title":"最近アクセスした項目のリストを取得","openapi":"box-openapi-jp.json GET /recent_items","description":"過去90日間、または最大1,000項目まで遡って、ユーザーが最近アクセスした項目に関する情報を返します。","href":"/ja/reference/get-recent-items"}]},{"group":"リテンションポリシー","root":{"title":"Retention policies resources","description":null,"href":"/reference/retention-policies-resources"},"pages":[{"title":"リテンションポリシーを取得","openapi":"box-openapi-jp.json GET /retention_policies/{retention_policy_id}","description":"リテンションポリシーを取得します。","href":"/ja/reference/get-retention-policies-id"},{"title":"リテンションポリシーのリストを取得","openapi":"box-openapi-jp.json GET /retention_policies","description":"会社のすべてのリテンションポリシーを取得します。","href":"/ja/reference/get-retention-policies"},{"title":"リテンションポリシーを作成","openapi":"box-openapi-jp.json POST /retention_policies","description":"リテンションポリシーを作成します。","href":"/ja/reference/post-retention-policies"},{"title":"リテンションポリシーを更新","openapi":"box-openapi-jp.json PUT /retention_policies/{retention_policy_id}","description":"リテンションポリシーを更新します。","href":"/ja/reference/put-retention-policies-id"},{"title":"リテンションポリシーを削除","openapi":"box-openapi-jp.json DELETE /retention_policies/{retention_policy_id}","description":"リテンションポリシーを完全に削除します。","href":"/ja/reference/delete-retention-policies-id"}]},{"group":"リテンションポリシー割り当て","root":{"title":"Retention policy assignments resources","description":null,"href":"/reference/retention-policy-assignments-resources"},"pages":[{"title":"リテンションの対象となるファイルバージョンを取得","openapi":"box-openapi-jp.json GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention","description":"リテンションポリシー割り当てのために、リテンションの対象となるファイルバージョンのリストを返します。","href":"/ja/reference/get-retention-policy-assignments-id-file-versions-under-retention"},{"title":"リテンションの対象となるファイルを取得","openapi":"box-openapi-jp.json GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention","description":"リテンションポリシー割り当てのために、リテンションの対象となるファイルのリストを返します。","href":"/ja/reference/get-retention-policy-assignments-id-files-under-retention"},{"title":"リテンションポリシー割り当てを取得","openapi":"box-openapi-jp.json GET /retention_policy_assignments/{retention_policy_assignment_id}","description":"リテンションポリシー割り当てを取得します。","href":"/ja/reference/get-retention-policy-assignments-id"},{"title":"リテンションポリシー割り当てのリストを取得","openapi":"box-openapi-jp.json GET /retention_policies/{retention_policy_id}/assignments","description":"指定したリテンションポリシーに関連付けられているすべてのリテンションポリシー割り当てのリストを返します。","href":"/ja/reference/get-retention-policies-id-assignments"},{"title":"リテンションポリシーを割り当て","openapi":"box-openapi-jp.json POST /retention_policy_assignments","description":"リテンションポリシーを項目に割り当てます。","href":"/ja/reference/post-retention-policy-assignments"},{"title":"リテンションポリシー割り当てを削除","openapi":"box-openapi-jp.json DELETE /retention_policy_assignments/{retention_policy_assignment_id}","description":"コンテンツに適用されたリテンションポリシー割り当てを削除します。","href":"/ja/reference/delete-retention-policy-assignments-id"}]},{"group":"検索","root":{"title":"Search resources","description":null,"href":"/reference/search-resources"},"pages":[{"title":"コンテンツを検索","openapi":"box-openapi-jp.json GET /search","description":"ユーザーのコンテンツまたは会社全体でファイル、フォルダ、ウェブリンク、および共有ファイルを検索します。","href":"/ja/reference/get-search"},{"title":"メタデータによるファイル/フォルダに対するクエリ","openapi":"box-openapi-jp.json POST /metadata_queries/execute_read","description":"SQLに似た構文で特定のメタデータと一致する項目を返す検索を作成します。\n\nデフォルトでは、このエンドポイントによって、クエリに一致する項目に関する最も基本的な情報のみが返されます。各項目のその他のフィールド (メタデータのいずれかを含む) を取得するには、クエリで`fields`属性を使用します。","href":"/ja/reference/post-metadata-queries-execute-read"}]},{"group":"セッション終了","root":{"title":"Session termination resources","description":null,"href":"/reference/session-termination-resources"},"pages":[{"title":"ユーザーグループのセッションを終了させるジョブを作成","openapi":"box-openapi-jp.json POST /groups/terminate_sessions","description":"グループのロールと権限を検証し、グループのセッションを終了させる非同期ジョブを作成します。POSTリクエストのステータスを返します。","href":"/ja/reference/post-groups-terminate-sessions"},{"title":"ユーザーのセッションを終了させるジョブを作成","openapi":"box-openapi-jp.json POST /users/terminate_sessions","description":"ユーザーのロールと権限を検証し、ユーザーのセッションを終了させる非同期ジョブを作成します。POSTリクエストのステータスを返します。","href":"/ja/reference/post-users-terminate-sessions"}]},{"group":"共有リンク (アプリ項目)","pages":[{"title":"共有リンクのアプリ項目を検索","openapi":"box-openapi-jp.json GET /shared_items#app_items","description":"共有リンクで表されるアプリ項目を返します。\n\nリンク元は、現在の企業でも別の企業でもかまいません。","href":"/ja/reference/get-shared-items--app-items"}]},{"group":"共有リンク (ファイル)","pages":[{"title":"共有リンクのファイルを検索","openapi":"box-openapi-jp.json GET /shared_items","description":"共有リンクで表されるファイルを返します。\n\n共有ファイルは、共有リンクで表すことが可能で、現在の会社内に存在する項目である場合も、別の会社内に存在する項目である場合もあります。\n\nアプリケーションからこのエンドポイントを呼び出すと、共有ファイルについての情報を取得できます (共有リンクが存在する場合のみ)。\n\n`shared_link_permission_options`の配列フィールドは、`fields`クエリパラメータでリクエストすると、返されます。","href":"/ja/reference/get-shared-items"},{"title":"ファイルの共有リンクを取得","openapi":"box-openapi-jp.json GET /files/{file_id}#get_shared_link","description":"ファイルの共有リンクの情報を取得します。","href":"/ja/reference/get-files-id--get-shared-link"},{"title":"ファイルに共有リンクを追加","openapi":"box-openapi-jp.json PUT /files/{file_id}#add_shared_link","description":"ファイルに共有リンクを追加します。","href":"/ja/reference/put-files-id--add-shared-link"},{"title":"ファイルから共有リンクを削除","openapi":"box-openapi-jp.json PUT /files/{file_id}#remove_shared_link","description":"ファイルから共有リンクを削除します。","href":"/ja/reference/put-files-id--remove-shared-link"},{"title":"ファイルの共有リンクを更新","openapi":"box-openapi-jp.json PUT /files/{file_id}#update_shared_link","description":"ファイルの共有リンクを更新します。","href":"/ja/reference/put-files-id--update-shared-link"}]},{"group":"共有リンク (フォルダ)","pages":[{"title":"共有リンクのフォルダを検索","openapi":"box-openapi-jp.json GET /shared_items#folders","description":"共有リンクで表されるフォルダを返します。\n\n共有フォルダは、共有リンクで表すことが可能で、現在の会社内に存在する項目である場合も、別の会社内に存在する項目である場合もあります。\n\nアプリケーションからこのエンドポイントを呼び出すと、共有フォルダについての情報を取得できます (共有リンクが存在する場合のみ)。","href":"/ja/reference/get-shared-items--folders"},{"title":"フォルダの共有リンクを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}#get_shared_link","description":"フォルダの共有リンクの情報を取得します。","href":"/ja/reference/get-folders-id--get-shared-link"},{"title":"フォルダに共有リンクを追加","openapi":"box-openapi-jp.json PUT /folders/{folder_id}#add_shared_link","description":"フォルダに共有リンクを追加します。","href":"/ja/reference/put-folders-id--add-shared-link"},{"title":"フォルダから共有リンクを削除","openapi":"box-openapi-jp.json PUT /folders/{folder_id}#remove_shared_link","description":"フォルダから共有リンクを削除します。","href":"/ja/reference/put-folders-id--remove-shared-link"},{"title":"フォルダの共有リンクを更新","openapi":"box-openapi-jp.json PUT /folders/{folder_id}#update_shared_link","description":"フォルダの共有リンクを更新します。","href":"/ja/reference/put-folders-id--update-shared-link"}]},{"group":"共有リンク (ウェブリンク)","pages":[{"title":"共有リンクのウェブリンクを検索","openapi":"box-openapi-jp.json GET /shared_items#web_links","description":"共有リンクで表されるウェブリンクを返します。\n\n共有ウェブリンクは、共有リンクで表すことが可能で、現在の企業内に存在する項目である場合も、別の企業内に存在する項目である場合もあります。\n\nアプリケーションからこのエンドポイントを呼び出すと、共有ウェブリンクについての情報を取得できます (共有リンクが存在する場合のみ)。","href":"/ja/reference/get-shared-items--web-links"},{"title":"ウェブリンクの共有リンクを取得","openapi":"box-openapi-jp.json GET /web_links/{web_link_id}#get_shared_link","description":"ウェブリンクの共有リンクの情報を取得します。","href":"/ja/reference/get-web-links-id--get-shared-link"},{"title":"ウェブリンクに共有リンクを追加","openapi":"box-openapi-jp.json PUT /web_links/{web_link_id}#add_shared_link","description":"ウェブリンクに共有リンクを追加します。","href":"/ja/reference/put-web-links-id--add-shared-link"},{"title":"ウェブリンクから共有リンクを削除","openapi":"box-openapi-jp.json PUT /web_links/{web_link_id}#remove_shared_link","description":"ウェブリンクから共有リンクを削除します。","href":"/ja/reference/put-web-links-id--remove-shared-link"},{"title":"ウェブリンクの共有リンクを更新","openapi":"box-openapi-jp.json PUT /web_links/{web_link_id}#update_shared_link","description":"ウェブリンクの共有リンクを更新します。","href":"/ja/reference/put-web-links-id--update-shared-link"}]},{"group":"Shield情報バリアレポート","root":{"title":"Shield information barrier reports resources","description":null,"href":"/reference/shield-information-barrier-reports-resources"},"pages":[{"title":"IDを指定してShield情報バリアレポートを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_reports/{shield_information_barrier_report_id}","description":"IDを指定してShield情報バリアレポートを取得します。","href":"/ja/reference/get-shield-information-barrier-reports-id"},{"title":"Shield情報バリアレポートのリストを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_reports","description":"Shield情報バリアレポートのリストを取得します。","href":"/ja/reference/get-shield-information-barrier-reports"},{"title":"Shield情報バリアレポートを作成","openapi":"box-openapi-jp.json POST /shield_information_barrier_reports","description":"指定されたバリアのShield情報バリアレポートを作成します。","href":"/ja/reference/post-shield-information-barrier-reports"}]},{"group":"Shield情報バリアのセグメントメンバー","root":{"title":"Shield information barrier segment members resources","description":null,"href":"/reference/shield-information-barrier-segment-members-resources"},"pages":[{"title":"IDを指定してShield情報バリアのセグメントメンバーを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","description":"IDを指定してShield情報バリアのセグメントメンバーを取得します。","href":"/ja/reference/get-shield-information-barrier-segment-members-id"},{"title":"Shield情報バリアのセグメントメンバーのリストを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_segment_members","description":"指定されたセグメントIDに基づいてShield情報バリアのセグメントメンバーのリストを取得します。","href":"/ja/reference/get-shield-information-barrier-segment-members"},{"title":"Shield情報バリアのセグメントメンバーを作成","openapi":"box-openapi-jp.json POST /shield_information_barrier_segment_members","description":"新しいShield情報バリアのセグメントメンバーを作成します。","href":"/ja/reference/post-shield-information-barrier-segment-members"},{"title":"IDを指定してShield情報バリアのセグメントメンバーを削除","openapi":"box-openapi-jp.json DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}","description":"指定されたIDに基づいてShield情報バリアのセグメントメンバーを削除します。","href":"/ja/reference/delete-shield-information-barrier-segment-members-id"}]},{"group":"Shield情報バリアのセグメント制限","root":{"title":"Shield information barrier segment restrictions resources","description":null,"href":"/reference/shield-information-barrier-segment-restrictions-resources"},"pages":[{"title":"IDを指定してShield情報バリアのセグメント制限を取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","description":"指定されたIDに基づいてShield情報バリアのセグメント制限を取得します。","href":"/ja/reference/get-shield-information-barrier-segment-restrictions-id"},{"title":"Shield情報バリアのセグメント制限のリストを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_segment_restrictions","description":"指定されたセグメントIDに基づいてShield情報バリアのセグメント制限のリストを取得します。","href":"/ja/reference/get-shield-information-barrier-segment-restrictions"},{"title":"Shield情報バリアのセグメント制限を作成","openapi":"box-openapi-jp.json POST /shield_information_barrier_segment_restrictions","description":"Shield情報バリアのセグメント制限オブジェクトを作成します。","href":"/ja/reference/post-shield-information-barrier-segment-restrictions"},{"title":"IDを指定してShield情報バリアのセグメント制限を削除","openapi":"box-openapi-jp.json DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}","description":"指定されたIDに基づいてShield情報バリアのセグメント制限を削除します。","href":"/ja/reference/delete-shield-information-barrier-segment-restrictions-id"}]},{"group":"Shield情報バリアのセグメント","root":{"title":"Shield information barrier segments resources","description":null,"href":"/reference/shield-information-barrier-segments-resources"},"pages":[{"title":"指定したIDのShield情報バリアのセグメントを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}","description":"指定されたIDに基づいてShield情報バリアのセグメントを取得します。","href":"/ja/reference/get-shield-information-barrier-segments-id"},{"title":"Shield情報バリアのセグメントのリストを取得","openapi":"box-openapi-jp.json GET /shield_information_barrier_segments","description":"指定した情報バリアIDのShield情報バリアのセグメントオブジェクトのリストを取得します。","href":"/ja/reference/get-shield-information-barrier-segments"},{"title":"Shield情報バリアのセグメントを作成","openapi":"box-openapi-jp.json POST /shield_information_barrier_segments","description":"Shield情報バリアのセグメントを作成します。","href":"/ja/reference/post-shield-information-barrier-segments"},{"title":"指定したIDのShield情報バリアのセグメントを更新","openapi":"box-openapi-jp.json PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}","description":"指定されたIDに基づいてShield情報バリアのセグメントを更新します。","href":"/ja/reference/put-shield-information-barrier-segments-id"},{"title":"Shield情報バリアのセグメントを削除","openapi":"box-openapi-jp.json DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}","description":"指定されたIDに基づいてShield情報バリアのセグメントを削除します。","href":"/ja/reference/delete-shield-information-barrier-segments-id"}]},{"group":"Shield情報バリア","root":{"title":"Shield information barriers resources","description":null,"href":"/reference/shield-information-barriers-resources"},"pages":[{"title":"指定したIDのShield情報バリアを取得","openapi":"box-openapi-jp.json GET /shield_information_barriers/{shield_information_barrier_id}","description":"指定されたIDに基づいてShield情報バリアを取得します。","href":"/ja/reference/get-shield-information-barriers-id"},{"title":"Shield情報バリアのリストを取得","openapi":"box-openapi-jp.json GET /shield_information_barriers","description":"JWTを使用している企業のShield情報バリアオブジェクトのリストを取得します。","href":"/ja/reference/get-shield-information-barriers"},{"title":"指定したIDのShield情報バリアの変更されたステータスを追加","openapi":"box-openapi-jp.json POST /shield_information_barriers/change_status","description":"指定されたIDのShield情報バリアのステータスを変更します。","href":"/ja/reference/post-shield-information-barriers-change-status"},{"title":"Shield情報バリアを作成","openapi":"box-openapi-jp.json POST /shield_information_barriers","description":"Shield情報バリアを作成して、同じ会社内で個人/グループを分離し、機密情報が互いにやり取りされるのを防ぎます。","href":"/ja/reference/post-shield-information-barriers"}]},{"group":"Skills","root":{"title":"Skills resources","description":null,"href":"/reference/skills-resources"},"pages":[{"title":"ファイルのBox Skillカードのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/metadata/global/boxSkillsCards","description":"ファイルに添付されているBox Skillsメタデータカードのリストを取得します。","href":"/ja/reference/get-files-id-metadata-global-boxSkillsCards"},{"title":"ファイルにBox Skillカードを作成","openapi":"box-openapi-jp.json POST /files/{file_id}/metadata/global/boxSkillsCards","description":"ファイルに1つ以上のBox Skillsメタデータカードを適用します。","href":"/ja/reference/post-files-id-metadata-global-boxSkillsCards"},{"title":"ファイルのすべてのBox Skillカードを更新","openapi":"box-openapi-jp.json PUT /skill_invocations/{skill_id}","description":"ファイルのすべてのBox Skillメタデータカードを上書きおよび更新するために使用できる代替方法。","href":"/ja/reference/put-skill-invocations-id"},{"title":"ファイルのBox Skillカードを更新","openapi":"box-openapi-jp.json PUT /files/{file_id}/metadata/global/boxSkillsCards","description":"ファイルの1つ以上のBox Skillsメタデータカードを更新します。","href":"/ja/reference/put-files-id-metadata-global-boxSkillsCards"},{"title":"ファイルからBox Skillカードを削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}/metadata/global/boxSkillsCards","description":"ファイルからBox Skillsカードのメタデータを削除します。","href":"/ja/reference/delete-files-id-metadata-global-boxSkillsCards"}]},{"group":"標準およびZonesのストレージポリシー","root":{"title":"Standard and Zones Storage Policies resources","description":null,"href":"/reference/storage-policies-resources"},"pages":[{"title":"ストレージポリシーを取得","openapi":"box-openapi-jp.json GET /storage_policies/{storage_policy_id}","description":"特定のストレージポリシーを取得します。","href":"/ja/reference/get-storage-policies-id"},{"title":"ストレージポリシーのリストを取得","openapi":"box-openapi-jp.json GET /storage_policies","description":"企業のすべてのストレージポリシーを取得します。","href":"/ja/reference/get-storage-policies"}]},{"group":"標準およびZonesのストレージポリシー割り当て","root":{"title":"Standard and Zones Storage Policy Assignments resources","description":null,"href":"/reference/storage-policy-assignments-resources"},"pages":[{"title":"ストレージポリシー割り当てを取得","openapi":"box-openapi-jp.json GET /storage_policy_assignments/{storage_policy_assignment_id}","description":"特定のストレージポリシー割り当てを取得します。","href":"/ja/reference/get-storage-policy-assignments-id"},{"title":"ストレージポリシー割り当てのリストを取得","openapi":"box-openapi-jp.json GET /storage_policy_assignments","description":"会社またはユーザーのすべてのストレージポリシー割り当てを取得します。","href":"/ja/reference/get-storage-policy-assignments"},{"title":"ストレージポリシーを割り当て","openapi":"box-openapi-jp.json POST /storage_policy_assignments","description":"会社またはユーザーに対するストレージポリシー割り当てを作成します。","href":"/ja/reference/post-storage-policy-assignments"},{"title":"ストレージポリシー割り当てを更新","openapi":"box-openapi-jp.json PUT /storage_policy_assignments/{storage_policy_assignment_id}","description":"特定のストレージポリシー割り当てを更新します。","href":"/ja/reference/put-storage-policy-assignments-id"},{"title":"ストレージポリシーの割り当てを解除","openapi":"box-openapi-jp.json DELETE /storage_policy_assignments/{storage_policy_assignment_id}","description":"ストレージポリシーの割り当てを削除します。\n\nユーザーに対するストレージポリシーの割り当てを削除すると、そのユーザーは会社のデフォルトのストレージポリシーを継承します。\n\nこのエンドポイントの呼び出しには、24時間につき1ユーザーあたり2回までというレート制限が適用されます。","href":"/ja/reference/delete-storage-policy-assignments-id"}]},{"group":"タスク割り当て","root":{"title":"Task assignments resources","description":null,"href":"/reference/task-assignments-resources"},"pages":[{"title":"タスク割り当てを取得","openapi":"box-openapi-jp.json GET /task_assignments/{task_assignment_id}","description":"タスク割り当てに関する情報を取得します。","href":"/ja/reference/get-task-assignments-id"},{"title":"タスク割り当てのリストを取得","openapi":"box-openapi-jp.json GET /tasks/{task_id}/assignments","description":"指定したタスクのすべての割り当てのリストを取得します。","href":"/ja/reference/get-tasks-id-assignments"},{"title":"タスクを割り当て","openapi":"box-openapi-jp.json POST /task_assignments","description":"ユーザーにタスクを割り当てます。\n\n複数の割り当てを作成することで、1つのタスクを複数のユーザーに割り当てることができます。","href":"/ja/reference/post-task-assignments"},{"title":"タスク割り当てを更新","openapi":"box-openapi-jp.json PUT /task_assignments/{task_assignment_id}","description":"タスク割り当てを更新します。このエンドポイントは、ユーザーに割り当てられたタスクの状態を更新する場合に使用できます。","href":"/ja/reference/put-task-assignments-id"},{"title":"タスク割り当てを解除","openapi":"box-openapi-jp.json DELETE /task_assignments/{task_assignment_id}","description":"特定のタスク割り当てを削除します。","href":"/ja/reference/delete-task-assignments-id"}]},{"group":"タスク","root":{"title":"Tasks resources","description":null,"href":"/reference/tasks-resources"},"pages":[{"title":"タスクを取得","openapi":"box-openapi-jp.json GET /tasks/{task_id}","description":"特定のタスクに関する情報を取得します。","href":"/ja/reference/get-tasks-id"},{"title":"ファイルに対するタスクのリストを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/tasks","description":"そのファイルに関連するすべてのタスクのリストを取得します。このエンドポイントはページネーションをサポートしていません。","href":"/ja/reference/get-files-id-tasks"},{"title":"タスクを作成","openapi":"box-openapi-jp.json POST /tasks","description":"ファイルに対する1個のタスクを作成します。このタスクはいずれのユーザーにも割り当てられていないため、個別に割り当てる必要があります。","href":"/ja/reference/post-tasks"},{"title":"タスクを更新","openapi":"box-openapi-jp.json PUT /tasks/{task_id}","description":"タスクを更新します。これは、タスクの構成を更新するため、またはその完了状態を更新するために使用できます。","href":"/ja/reference/put-tasks-id"},{"title":"タスクを削除","openapi":"box-openapi-jp.json DELETE /tasks/{task_id}","description":"ファイルからタスクを削除します。","href":"/ja/reference/delete-tasks-id"}]},{"group":"サービス利用規約","root":{"title":"Terms of service resources","description":null,"href":"/reference/terms-of-services-resources"},"pages":[{"title":"サービス利用規約を取得","openapi":"box-openapi-jp.json GET /terms_of_services/{terms_of_service_id}","description":"特定のサービス利用規約を取得します。","href":"/ja/reference/get-terms-of-services-id"},{"title":"サービス利用規約のリストを取得","openapi":"box-openapi-jp.json GET /terms_of_services","description":"企業の現在のサービス利用規約のテキストと設定を返します。","href":"/ja/reference/get-terms-of-services"},{"title":"サービス利用規約を作成","openapi":"box-openapi-jp.json POST /terms_of_services","description":"指定した企業とユーザータイプに適用されるサービス利用規約を作成します。","href":"/ja/reference/post-terms-of-services"},{"title":"サービス利用規約を更新","openapi":"box-openapi-jp.json PUT /terms_of_services/{terms_of_service_id}","description":"特定のサービス利用規約を更新します。","href":"/ja/reference/put-terms-of-services-id"}]},{"group":"サービス利用規約のユーザーステータス","root":{"title":"Terms of service user statuses resources","description":null,"href":"/reference/terms-of-service-user-statuses-resources"},"pages":[{"title":"サービス利用規約のユーザーステータスのリストを取得","openapi":"box-openapi-jp.json GET /terms_of_service_user_statuses","description":"ユーザーとそのユーザーに適用されるサービス利用規約のステータスの概要 (ユーザーが利用規約に同意したかどうかや、いつ同意したかなど) を取得します。","href":"/ja/reference/get-terms-of-service-user-statuses"},{"title":"新規ユーザーのサービス利用規約のステータスを作成","openapi":"box-openapi-jp.json POST /terms_of_service_user_statuses","description":"ユーザーのサービス利用規約のステータスを設定します。","href":"/ja/reference/post-terms-of-service-user-statuses"},{"title":"既存ユーザーのサービス利用規約のステータスを更新","openapi":"box-openapi-jp.json PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}","description":"ユーザーのサービス利用規約のステータスを更新します。","href":"/ja/reference/put-terms-of-service-user-statuses-id"}]},{"group":"フォルダの移動","pages":[{"title":"所有フォルダの移動","openapi":"box-openapi-jp.json PUT /users/{user_id}/folders/0","description":"ユーザーが所有するすべての項目 (ファイル、フォルダ、およびワークフロー) を別のユーザーのアカウントに移動します。\n\n転送できるのは、ルートフォルダ (`0`) のみです。\n\nユーザー間でフォルダを移動できるのは、管理者権限を持つユーザーのみです。\n\n既存の共有リンクとフォルダレベルのコラボレーションはすべて、操作中に転送されます。個々のファイルレベルでのコラボレーションは操作中に転送されますが、元のユーザーが削除されるとこれらのコラボレーションは削除されることに注意してください。\n\nユーザーのすべてのフォルダに多数の項目がある場合、コールは非同期的に実行されます。この操作が10分以内に完了しない場合、ユーザーには200 OKのレスポンスが返され、操作は続行されます。\n\n宛先パスのいずれかの親フォルダにメタデータカスケードポリシーが適用されている場合は、メタデータカスケード操作が非同期的に開始されます。\n\n現時点では、この操作がいつ終了したのかを確認する方法はありません。\n\n宛先フォルダの名前は、`{User}'s Files and Folders`形式になります。この場合、`{User}`はユーザーの表示名です。\n\nこのAPIコールを行うには、アプリケーションで \\[Boxに格納されているすべてのファイルとフォルダの読み取りと書き込み] スコープを有効にしておく必要があります。\n\n転送先ユーザーが`Relay`または`Relay Lite`にアクセスできることと転送中のワークフローに関与するファイルやフォルダにアクセスできることを確認してください。\n\n操作が完了すると、管理者にメールが届きます。","href":"/ja/reference/put-users-id-folders-0"}]},{"group":"ごみ箱内のファイル","root":{"title":"Trashed files resources","description":null,"href":"/reference/trashed-files-resources"},"pages":[{"title":"ごみ箱内のファイルを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/trash","description":"ごみ箱に移動されたファイルを取得します。\n\nそのファイル自体がごみ箱に移動されている場合のみ、このAPIコールを使用して取得できることに注意してください。そうではなく、その親フォルダのいずれかがごみ箱に移動された場合、[`GET /folders/:id/trash`](/reference/get-folders-id-trash) APIを使用して調べることができるのは、そのフォルダのみです。\n\nごみ箱に移動されたすべての項目のリストを取得するには、[`GET /folders/trash/items`](/reference/get-folders-trash-items/) APIを使用します。","href":"/ja/reference/get-files-id-trash"},{"title":"ファイルを復元","openapi":"box-openapi-jp.json POST /files/{file_id}","description":"ごみ箱に移動されたファイルを復元します。\n\n元のフォルダが削除されている場合にフォルダの復元先となる新しい親ID (省略可) を指定することができます。","href":"/ja/reference/post-files-id"},{"title":"ファイルを完全に削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}/trash","description":"ごみ箱内にあるファイルを完全に削除します。このアクションは取り消せません。","href":"/ja/reference/delete-files-id-trash"}]},{"group":"ごみ箱内のフォルダ","root":{"title":"Trashed folders resources","description":null,"href":"/reference/trashed-folders-resources"},"pages":[{"title":"ごみ箱内のフォルダを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/trash","description":"ごみ箱に移動されたフォルダを取得します。\n\nそのフォルダ自体がごみ箱に移動されている場合のみ、このAPIコールを使用して取得できることに注意してください。そうではなく、その親フォルダのいずれかがごみ箱に移動された場合、[`GET /folders/:id/trash`](/reference/get-folders-id-trash) APIを使用して調べることができるのは、そのフォルダのみです。\n\nごみ箱に移動されたすべての項目のリストを取得するには、[`GET /folders/trash/items`](/reference/get-folders-trash-items/) APIを使用します。","href":"/ja/reference/get-folders-id-trash"},{"title":"フォルダを復元","openapi":"box-openapi-jp.json POST /folders/{folder_id}","description":"ごみ箱に移動されたフォルダを復元します。\n\n元のフォルダが削除されている場合にフォルダの復元先となる新しい親ID (省略可) を指定することができます。\n\nこの操作の進行中は、ファイルツリーの一部がロックされます。ロックされるのは主に元のフォルダとその子孫フォルダ、および宛先フォルダです。\n\n操作の進行中は、ロックされたどのフォルダに対しても、その他の移動、コピー、削除または復元操作を実行できません。","href":"/ja/reference/post-folders-id"},{"title":"フォルダを完全に削除","openapi":"box-openapi-jp.json DELETE /folders/{folder_id}/trash","description":"ごみ箱内にあるフォルダを完全に削除します。この操作は元に戻すことができません。","href":"/ja/reference/delete-folders-id-trash"}]},{"group":"ごみ箱内の項目","pages":[{"title":"ごみ箱内の項目のリストを取得","openapi":"box-openapi-jp.json GET /folders/trash/items","description":"ごみ箱に移動されたファイルとフォルダを取得します。\n\n`fields`パラメータを使用して完全版のファイルオブジェクトまたはフォルダオブジェクト内の任意の属性を渡すと、デフォルトでは返されない特定の属性を取得できます。\n\nこのエンドポイントはデフォルトでオフセットベースのページネーションを使用しますが、`marker`パラメータを使用したマーカーベースのページネーションもサポートしています。\n\n返されるエントリの数は`total_count`未満になる場合があります。例えば、ユーザーが共有フォルダから項目を削除し、その後コラボレータから削除された場合、それらの削除された項目が`total_count`に含まれていても、このエンドポイントの結果には表示されなくなります。","href":"/ja/reference/get-folders-trash-items"}]},{"group":"ごみ箱内のウェブリンク","root":{"title":"Trashed web links resources","description":null,"href":"/reference/trashed-web-links-resources"},"pages":[{"title":"ごみ箱に移動されたウェブリンクを取得","openapi":"box-openapi-jp.json GET /web_links/{web_link_id}/trash","description":"ごみ箱に移動されたウェブリンクを取得します。","href":"/ja/reference/get-web-links-id-trash"},{"title":"ウェブリンクを復元","openapi":"box-openapi-jp.json POST /web_links/{web_link_id}","description":"ごみ箱に移動されたウェブリンクを復元します。\n\n元のフォルダが削除されている場合にウェブリンクの復元先となる新しい親ID (省略可) を指定することができます。","href":"/ja/reference/post-web-links-id"},{"title":"ウェブリンクを完全に削除","openapi":"box-openapi-jp.json DELETE /web_links/{web_link_id}/trash","description":"ごみ箱内にあるウェブリンクを完全に削除します。この操作は元に戻すことができません。","href":"/ja/reference/delete-web-links-id-trash"}]},{"group":"アップロード","root":{"title":"Uploads resources","description":null,"href":"/reference/uploads-resources"},"pages":[{"title":"ファイルをアップロード","openapi":"box-openapi-jp.json POST /files/content","description":"小さいファイルをBoxにアップロードします。ファイルサイズが50 MBを超える場合は、分割アップロードAPIを使用することをお勧めします。\n\n本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。","href":"/ja/reference/post-files-content"},{"title":"ファイルバージョンをアップロード","openapi":"box-openapi-jp.json POST /files/{file_id}/content","description":"ファイルのコンテンツを更新します。ファイルサイズが50 MBを超える場合は、分割アップロードAPIを使用することをお勧めします。\n\n本文の`attributes`部分は`file`部分の**前**に置く必要があります。ファイルのアップロード時にリクエストがこの形式に従っていない場合は、HTTP `400`エラーと`metadata_after_file_contents`エラーコードが返されます。","href":"/ja/reference/post-files-id-content"},{"title":"アップロード前の事前チェック","openapi":"/box-openapi-jp.json OPTIONS /files/content","description":null,"href":"/ja/reference/options-files-content"}]},{"group":"アップロード (分割)","root":{"title":"Uploads (Chunked) resources","description":null,"href":"/reference/chunked-uploads-resources"},"pages":[{"title":"アップロードセッションを取得","openapi":"box-openapi-jp.json GET /files/upload_sessions/{upload_session_id}","description":"アップロードセッションに関する情報を返します。\n\n実際のエンドポイントURLは[`Create upload session`](/reference/post-files-upload-sessions)エンドポイントが返します。","href":"/ja/reference/get-files-upload-sessions-id"},{"title":"パーツのリストを取得","openapi":"box-openapi-jp.json GET /files/upload_sessions/{upload_session_id}/parts","description":"現在までにアップロードセッションにアップロードされたチャンクのリストを返します。\n\n実際のエンドポイントURLは[`Create upload session`](/reference/post-files-upload-sessions)および[`Get upload session`](/reference/get-files-upload-sessions-id)エンドポイントが返します。","href":"/ja/reference/get-files-upload-sessions-id-parts"},{"title":"アップロードセッションをコミット","openapi":"box-openapi-jp.json POST /files/upload_sessions/{upload_session_id}/commit","description":"アップロードセッションを閉じて、アップロード済みのチャンクからファイルを作成します。\n\n実際のエンドポイントURLは[`Create upload session`](/reference/post-files-upload-sessions)および[`Get upload session`](/reference/get-files-upload-sessions-id)エンドポイントが返します。","href":"/ja/reference/post-files-upload-sessions-id-commit"},{"title":"アップロードセッションを作成","openapi":"box-openapi-jp.json POST /files/upload_sessions","description":"新しいファイルのアップロードセッションを作成します。","href":"/ja/reference/post-files-upload-sessions"},{"title":"既存ファイルのアップロードセッションを作成","openapi":"box-openapi-jp.json POST /files/{file_id}/upload_sessions","description":"既存ファイルのアップロードセッションを作成します。","href":"/ja/reference/post-files-id-upload-sessions"},{"title":"Post files upload sessions id plan","href":"/ja/reference/post-files-upload-sessions-id-plan"},{"title":"ファイルの一部をアップロード","openapi":"box-openapi-jp.json PUT /files/upload_sessions/{upload_session_id}","description":"アップロードセッションでファイルのチャンクをアップロードします。\n\n実際のエンドポイントURLは[`Create upload session`](/reference/post-files-upload-sessions)および[`Get upload session`](/reference/get-files-upload-sessions-id)エンドポイントが返します。","href":"/ja/reference/put-files-upload-sessions-id"},{"title":"アップロードセッションを削除","openapi":"box-openapi-jp.json DELETE /files/upload_sessions/{upload_session_id}","description":"アップロードセッションを中断して、アップロードされたすべてのデータを破棄します。\n\nこの操作は元に戻せません。\n\n実際のエンドポイントURLは[`Create upload session`](/reference/post-files-upload-sessions)および[`Get upload session`](/reference/get-files-upload-sessions-id)エンドポイントが返します。","href":"/ja/reference/delete-files-upload-sessions-id"}]},{"group":"ユーザーのアバター","root":{"title":"User avatars resources","description":null,"href":"/reference/avatars-resources"},"pages":[{"title":"ユーザーのアバターを取得","openapi":"box-openapi-jp.json GET /users/{user_id}/avatar","description":"ユーザーのアバターの画像を取得します。","href":"/ja/reference/get-users-id-avatar"},{"title":"ユーザーのアバターを追加または更新","openapi":"box-openapi-jp.json POST /users/{user_id}/avatar","description":"ユーザーのアバターを追加または更新します。","href":"/ja/reference/post-users-id-avatar"},{"title":"ユーザーのアバターを削除","openapi":"box-openapi-jp.json DELETE /users/{user_id}/avatar","description":"既存のユーザーのアバターを削除します。この操作を元に戻すことはできません。","href":"/ja/reference/delete-users-id-avatar"}]},{"group":"ユーザー","root":{"title":"Users resources","description":null,"href":"/reference/users-resources"},"pages":[{"title":"現在のユーザーを取得","openapi":"box-openapi-jp.json GET /users/me","description":"現在認証されているユーザーに関する情報を取得します。\n\nクライアント側で認証されるOAuth 2.0アプリケーションの場合、これはアプリケーションを承認したユーザーになります。\n\nサーバー側でアプリケーションが認証されるJWTの場合、これはデフォルトでアプリケーションに属するサービスアカウントになります。\n\nこのAPIコールに使用するユーザーを変更するには、`As-User`ヘッダーを使用します。","href":"/ja/reference/get-users-me"},{"title":"ユーザーを取得","openapi":"box-openapi-jp.json GET /users/{user_id}","description":"企業内のユーザーに関する情報を取得します。\n\n会社全体のユーザーを参照するには、アプリケーションと認証済みユーザーに適切な権限が付与されている必要があります。\n\nまた、このエンドポイントは、適切なスコープを持つ認証済みユーザー用として会社が所有するコンテンツでコラボレーションを行う外部ユーザーに対しては、一部の情報のみを返します。その場合、権限が与えられていないフィールドについては、nullが返されます。","href":"/ja/reference/get-users-id"},{"title":"会社ユーザーのリストを取得","openapi":"box-openapi-jp.json GET /users","description":"会社の全ユーザーのリストを、各ユーザーの`user_id`、`public_name`、`login`とともに返します。\n\n会社全体のユーザーを参照するには、アプリケーションと認証済みユーザーに適切な権限が付与されている必要があります。","href":"/ja/reference/get-users"},{"title":"ユーザーを作成","openapi":"box-openapi-jp.json POST /users","description":"会社内の管理対象ユーザーを新規に作成します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。","href":"/ja/reference/post-users"},{"title":"ユーザーを更新","openapi":"box-openapi-jp.json PUT /users/{user_id}","description":"企業内の管理対象ユーザーまたはApp Userを更新します。このエンドポイントを使用できるのは、適切な管理者権限を持つユーザーとアプリケーションのみです。","href":"/ja/reference/put-users-id"},{"title":"ユーザーを削除","openapi":"box-openapi-jp.json DELETE /users/{user_id}","description":"ユーザーを削除します。デフォルトでは、ユーザーがまだコンテンツを所有している場合、この操作は失敗します。続行するには、最初にユーザーが所有するコンテンツを移動するか、`force`パラメータを使用してユーザーとそのユーザーが所有するファイルを削除します。","href":"/ja/reference/delete-users-id"}]},{"group":"電子すかし (ファイル)","root":{"title":"Watermarks (Files) resources","description":null,"href":"/reference/file-watermarks-resources"},"pages":[{"title":"ファイルの電子すかしを取得","openapi":"box-openapi-jp.json GET /files/{file_id}/watermark","description":"ファイルの電子すかしを取得します。","href":"/ja/reference/get-files-id-watermark"},{"title":"ファイルに電子すかしを適用","openapi":"box-openapi-jp.json PUT /files/{file_id}/watermark","description":"ファイルの電子すかしを適用または更新します。","href":"/ja/reference/put-files-id-watermark"},{"title":"ファイルから電子すかしを削除","openapi":"box-openapi-jp.json DELETE /files/{file_id}/watermark","description":"ファイルから電子すかしを削除します。","href":"/ja/reference/delete-files-id-watermark"}]},{"group":"電子すかし (フォルダ)","pages":[{"title":"フォルダの電子すかしを取得","openapi":"box-openapi-jp.json GET /folders/{folder_id}/watermark","description":"フォルダの電子すかしを取得します。","href":"/ja/reference/get-folders-id-watermark"},{"title":"フォルダに電子すかしを適用","openapi":"box-openapi-jp.json PUT /folders/{folder_id}/watermark","description":"フォルダの電子すかしを適用または更新します。","href":"/ja/reference/put-folders-id-watermark"},{"title":"フォルダから電子すかしを削除","openapi":"box-openapi-jp.json DELETE /folders/{folder_id}/watermark","description":"フォルダから電子すかしを削除します。","href":"/ja/reference/delete-folders-id-watermark"}]},{"group":"ウェブリンク","root":{"title":"Web links resources","description":null,"href":"/reference/web-links-resources"},"pages":[{"title":"ウェブリンクを取得","openapi":"box-openapi-jp.json GET /web_links/{web_link_id}","description":"ウェブリンクに関する情報を取得します。","href":"/ja/reference/get-web-links-id"},{"title":"ウェブリンクを作成","openapi":"box-openapi-jp.json POST /web_links","description":"フォルダ内にウェブリンクオブジェクトを作成します。","href":"/ja/reference/post-web-links"},{"title":"ウェブリンクを更新","openapi":"box-openapi-jp.json PUT /web_links/{web_link_id}","description":"ウェブリンクオブジェクトを更新します。","href":"/ja/reference/put-web-links-id"},{"title":"ウェブリンクを削除","openapi":"box-openapi-jp.json DELETE /web_links/{web_link_id}","description":"ウェブリンクを削除します。","href":"/ja/reference/delete-web-links-id"}]},{"group":"Webhook","root":{"title":"Webhooks resources","description":null,"href":"/reference/webhooks-resources"},"pages":[{"title":"Webhookを取得","openapi":"box-openapi-jp.json GET /webhooks/{webhook_id}","description":"特定のWebhookを取得します。","href":"/ja/reference/get-webhooks-id"},{"title":"すべてのWebhookのリストを取得","openapi":"box-openapi-jp.json GET /webhooks","description":"リクエスト元のアプリケーションに対して定義されているすべてのWebhookを返します。\n\nこのAPIは、認証済みユーザーが所有するファイルまたはフォルダに適用されているWebhookのみを返します。つまり、管理者は、それらのフォルダにアクセスできない限り、サービスアカウントによって作成されたWebhookを表示することはできません。逆もまた同様です。","href":"/ja/reference/get-webhooks"},{"title":"Webhookを作成","openapi":"box-openapi-jp.json POST /webhooks","description":"Webhookを作成します。","href":"/ja/reference/post-webhooks"},{"title":"Webhookを更新","openapi":"box-openapi-jp.json PUT /webhooks/{webhook_id}","description":"Webhookを更新します。","href":"/ja/reference/put-webhooks-id"},{"title":"Webhookを削除","openapi":"box-openapi-jp.json DELETE /webhooks/{webhook_id}","description":"Webhookを削除します。","href":"/ja/reference/delete-webhooks-id"}]},{"group":"ワークフロー","root":{"title":"Workflows resources","description":null,"href":"/reference/workflows-resources"},"pages":[{"title":"ワークフローのリストを取得","openapi":"box-openapi-jp.json GET /workflows","description":"指定した`folder ID`に作用し、トリガータイプが`WORKFLOW_MANUAL_START`のフローを含むワークフローのリストを返します。\n\nアプリケーションは、このエンドポイントを使用するために、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。","href":"/ja/reference/get-workflows"},{"title":"リクエスト本文に基づいてワークフローを開始","openapi":"box-openapi-jp.json POST /workflows/{workflow_id}/start","description":"トリガータイプが`WORKFLOW_MANUAL_START`のフローを開始します。\n\nアプリケーションは、開発者コンソールでの`Manage Box Relay`アプリケーションスコープの使用が承認されている必要があります。","href":"/ja/reference/post-workflows-id-start"}]},{"group":"zipダウンロード","root":{"title":"Zip Downloads resources","description":null,"href":"/reference/zip-downloads-resources"},"pages":[{"title":"zipアーカイブをダウンロード","openapi":"box-openapi-jp.json GET /zip_downloads/{zip_download_id}/content","description":"`zip`アーカイブのコンテンツをバイナリ形式で返します。このURLは、どのような形式の認証も要求せず、ユーザーのブラウザでユーザーのデバイスにアーカイブをダウンロードする際に使用できます。\n\nデフォルトでは、このURLの有効期間は、このアーカイブに対するリクエストを作成してから数秒間だけです。一度ダウンロードが開始されると、停止して再開することはできません。代わりに、zipアーカイブに対する新しいリクエストを作成する必要があります。\n\nこのエンドポイントのURLは固定であるとは考えないでください。代わりに、[zipダウンロードを作成](/reference/post-zip-downloads)APIを使用して`zip`アーカイブの作成をリクエストした後、このエンドポイントのレスポンスにある`download_url`フィールドに従ってください。","href":"/ja/reference/get-zip-downloads-id-content"},{"title":"zipダウンロードのステータスを取得","openapi":"box-openapi-jp.json GET /zip_downloads/{zip_download_id}/status","description":"`zip`アーカイブのダウンロードステータスを返します。これにより、アプリケーションは、ダウンロードの進行状況のほか、スキップされた可能性のある項目の数を確認できます。\n\nこのエンドポイントにアクセスできるのは、ダウンロードが開始された後だけです。このエンドポイントの有効期間は、ダウンロードを開始してから12時間です。\n\nこのエンドポイントのURLは固定であるとは考えないでください。代わりに、[zipダウンロードを作成](/reference/post-zip-downloads)APIを使用して`zip`アーカイブの作成をリクエストした後、このエンドポイントのレスポンスにある`status_url`フィールドに従ってください。","href":"/ja/reference/get-zip-downloads-id-status"},{"title":"zipダウンロードを作成","openapi":"box-openapi-jp.json POST /zip_downloads","description":"複数のファイルやフォルダを1つの`zip`アーカイブファイルとしてダウンロードするためのリクエストを作成します。このAPIでは、アーカイブは返されませんが、代わりにユーザーがすべての項目にアクセスできるかどうかを確認するチェックがすべて実行され、アーカイブのダウンロードに使用できる`download_url`および`status_url`が返されます。\n\nアーカイブの上限は、アカウントのアップロード上限または10,000ファイルのいずれかで、最初に達した上限が適用されます。\n\n**注**: 大きいファイルをダウンロードする場合は、距離、ネットワーク遅延、帯域幅、輻輳のほか、パケット損失率や現在のサーバー負荷など、さまざまな要因の影響を受けることがあります。このような理由から、Boxでは、ZIPアーカイブの合計サイズが25 GBを超えないようにすることをお勧めします。","href":"/ja/reference/post-zip-downloads"}]}]},{"group":"v2025.0","pages":[{"group":"アーカイブ","root":{"title":"Archives resources","description":null,"href":"/reference/v2025.0/archives-resources"},"pages":[{"title":"アーカイブのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /archives","description":"企業用のアーカイブを取得します。\n\nアーカイブのAPIの詳細については、[Archive APIガイド](/guides/archives)を参照してください。","href":"/ja/reference/v2025.0/get-archives"},{"title":"アーカイブを作成","openapi":"box-openapi-v2025.0-jp.json POST /archives","description":"アーカイブを作成します。\n\nアーカイブのAPIの詳細については、[Archive APIガイド](/guides/archives)を参照してください。","href":"/ja/reference/v2025.0/post-archives"},{"title":"アーカイブを更新","openapi":"box-openapi-v2025.0-jp.json PUT /archives/{archive_id}","description":"アーカイブを更新します。\n\nアーカイブのAPIの詳細については、[Archive APIガイド](/guides/archives)を参照してください。","href":"/ja/reference/v2025.0/put-archives-id"},{"title":"アーカイブを削除","openapi":"box-openapi-v2025.0-jp.json DELETE /archives/{archive_id}","description":"アーカイブを完全に削除します。\n\nアーカイブのAPIの詳細については、[Archive APIガイド](/guides/archives)を参照してください。\n\n\u003cdanger>\nこのエンドポイントは、現在使用できません。サポートまでお問い合わせください。\n\u003c/danger>","href":"/ja/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":"IDを指定してBox Doc Genジョブを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_jobs/{job_id}","description":"Box Doc Genジョブの詳細を取得します。","href":"/ja/reference/v2025.0/get-docgen-jobs-id"},{"title":"バッチIDを指定してBox Doc Genジョブを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_batch_jobs/{batch_id}","description":"バッチ内のBox Doc Genジョブのリストを取得します。","href":"/ja/reference/v2025.0/get-docgen-batch-jobs-id"},{"title":"すべてのBox Doc Genジョブのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_jobs","description":"1人のユーザーのすべてのBox Doc Genジョブのリストを取得します。","href":"/ja/reference/v2025.0/get-docgen-jobs"},{"title":"Box Doc Genテンプレートを使用してドキュメントを生成","openapi":"box-openapi-v2025.0-jp.json POST /docgen_batches","description":"Box Doc Genテンプレートを使用してドキュメントを生成します。","href":"/ja/reference/v2025.0/post-docgen-batches"}]},{"group":"Box Doc Genテンプレート","root":{"title":"Box Doc Gen templates resources","description":null,"href":"/reference/v2025.0/docgen-template-resources"},"pages":[{"title":"IDを指定してBox Doc Genテンプレートを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_templates/{template_id}","description":"特定のBox Doc Genテンプレートの詳細のリストを取得します。","href":"/ja/reference/v2025.0/get-docgen-templates-id"},{"title":"テンプレートのすべてのBox Doc Genジョブのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_template_jobs/{template_id}","description":"このテンプレートを使用するユーザーのジョブのリストを取得します。","href":"/ja/reference/v2025.0/get-docgen-template-jobs-id"},{"title":"テンプレート内のすべてのBox Doc Genテンプレートタグのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_templates/{template_id}/tags","description":"Box Doc Genテンプレート内のすべてのタグのリストを取得します。","href":"/ja/reference/v2025.0/get-docgen-templates-id-tags"},{"title":"Box Doc Genテンプレートのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /docgen_templates","description":"ユーザーがコラボレータになっているBox Doc Genテンプレートのリストを取得します。","href":"/ja/reference/v2025.0/get-docgen-templates"},{"title":"Box Doc Genテンプレートを作成","openapi":"box-openapi-v2025.0-jp.json POST /docgen_templates","description":"ファイルをBox Doc Genテンプレートとして設定します。","href":"/ja/reference/v2025.0/post-docgen-templates"},{"title":"Box Doc Genテンプレートを削除","openapi":"box-openapi-v2025.0-jp.json DELETE /docgen_templates/{template_id}","description":"ファイルのBox Doc Genテンプレートの設定を解除します。","href":"/ja/reference/v2025.0/delete-docgen-templates-id"}]},{"group":"Box Hubコラボレーション","root":{"title":"Box Hub Collaborations resources","description":null,"href":"/reference/v2025.0/hub-collaborations-resources"},"pages":[{"title":"コラボレーションIDを指定してBox Hubコラボレーションを取得","openapi":"box-openapi-v2025.0-jp.json GET /hub_collaborations/{hub_collaboration_id}","description":"コラボレーションIDを指定してBox Hubコラボレーションの詳細を取得します。","href":"/ja/reference/v2025.0/get-hub-collaborations-id"},{"title":"Box Hubコラボレーションを取得","openapi":"box-openapi-v2025.0-jp.json GET /hub_collaborations","description":"Box Hubのすべてのコラボレーションを取得します。","href":"/ja/reference/v2025.0/get-hub-collaborations"},{"title":"Box Hubコラボレーションを作成","openapi":"box-openapi-v2025.0-jp.json POST /hub_collaborations","description":"Box Hubに個々のユーザーまたはグループのコラボレーションを追加します。\n\nコラボレーションは、メールアドレス、ユーザーID、またはグループIDを使用して作成できます。","href":"/ja/reference/v2025.0/post-hub-collaborations"},{"title":"Box Hubコラボレーションを更新","openapi":"box-openapi-v2025.0-jp.json PUT /hub_collaborations/{hub_collaboration_id}","description":"Box Hubコラボレーションを更新します。これは、Box Hubのロールを変更するのに使用できます。","href":"/ja/reference/v2025.0/put-hub-collaborations-id"},{"title":"Box Hubコラボレーションを削除","openapi":"box-openapi-v2025.0-jp.json DELETE /hub_collaborations/{hub_collaboration_id}","description":"1つのBox Hubコラボレーションを削除します。","href":"/ja/reference/v2025.0/delete-hub-collaborations-id"}]},{"group":"Box Hubドキュメント","root":{"title":"Box Hub Document resources","description":null,"href":"/reference/v2025.0/hub-document-resources"},"pages":[{"title":"ページのHubドキュメントブロックのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /hub_document_blocks","description":"Hubドキュメント内の指定されたページ上にあるすべてのHubドキュメントブロック (項目を除く) の並べ替えられたリストを取得します。ブロックは、その`parent_id`別に階層化され、ユーザーインターフェースでのユーザーの指定に基づいた順で並べ替えられます。レスポンスには、指定されたページに属しているコンテンツブロックのみが含まれます。サブページやサブページのコンテンツブロックは含まれません。","href":"/ja/reference/v2025.0/get-hub-document-blocks"},{"title":"Hubドキュメントページのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /hub_document_pages","description":"指定されたHubのHubドキュメントページのリストを取得します。ルートレベルのページとサブページの両方が含まれます。","href":"/ja/reference/v2025.0/get-hub-document-pages"}]},{"group":"Box Hubの項目","root":{"title":"Box Hub Items resources","description":null,"href":"/reference/v2025.0/hub-items-resources"},"pages":[{"title":"Box Hubの項目を取得","openapi":"box-openapi-v2025.0-jp.json GET /hub_items","description":"Box Hubに関連付けられているすべての項目を取得します。","href":"/ja/reference/v2025.0/get-hub-items"},{"title":"Box Hubの項目を管理","openapi":"box-openapi-v2025.0-jp.json POST /hubs/{hub_id}/manage_items","description":"Box HubからBox Hubの項目を追加または削除します。","href":"/ja/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":"IDを指定してBox Hubの情報を取得","openapi":"box-openapi-v2025.0-jp.json GET /hubs/{hub_id}","description":"IDを指定してBox Hubの詳細を取得します。","href":"/ja/reference/v2025.0/get-hubs-id"},{"title":"すべてのBox Hubのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /hubs","description":"リクエストしているユーザーのすべてのBox Hubを取得します。","href":"/ja/reference/v2025.0/get-hubs"},{"title":"リクエストしている企業のすべてのBox Hubのリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /enterprise_hubs","description":"指定した企業のすべてのBox Hubを取得します。\n\nこのコールは、GCMスコープが設定されている、企業の管理者またはHub共同管理者が実行できます。","href":"/ja/reference/v2025.0/get-enterprise-hubs"},{"title":"Box Hubをコピー","openapi":"box-openapi-v2025.0-jp.json POST /hubs/{hub_id}/copy","description":"Box Hubのコピーを作成します。\n\n元のBox Hubは変更されません。","href":"/ja/reference/v2025.0/post-hubs-id-copy"},{"title":"Box Hubを作成","openapi":"box-openapi-v2025.0-jp.json POST /hubs","description":"新しいBox Hubを作成します。","href":"/ja/reference/v2025.0/post-hubs"},{"title":"IDを指定してBox Hubの情報を更新","openapi":"box-openapi-v2025.0-jp.json PUT /hubs/{hub_id}","description":"Box Hubを更新します。タイトル、説明、またはBox Hubの設定の変更に使用できます。","href":"/ja/reference/v2025.0/put-hubs-id"},{"title":"Box Hubを削除","openapi":"box-openapi-v2025.0-jp.json DELETE /hubs/{hub_id}","description":"1つのBox Hubを削除します。","href":"/ja/reference/v2025.0/delete-hubs-id"}]},{"group":"Enterprise構成","root":{"title":"Enterprise Configurations resources","description":null,"href":"/reference/v2025.0/enterprise-configurations-resources"},"pages":[{"title":"Enterprise構成を取得","openapi":"box-openapi-v2025.0-jp.json GET /enterprise_configurations/{enterprise_id}","description":"Enterprise構成を取得します。","href":"/ja/reference/v2025.0/get-enterprise-configurations-id"}]},{"group":"外部ユーザー","root":{"title":"External Users resources","description":null,"href":"/reference/v2025.0/external-users-resources"},"pages":[{"title":"外部ユーザーの削除ジョブを送信","openapi":"box-openapi-v2025.0-jp.json POST /external_users/submit_delete_job","description":"現在のユーザーの企業から外部ユーザーを削除します。これにより、現在の企業内で招待されたすべてのコラボレーションから各外部ユーザーが削除されます。","href":"/ja/reference/v2025.0/post-external-users-submit-delete-job"}]},{"group":"Shieldリスト","root":{"title":"Shield lists resources","description":null,"href":"/reference/v2025.0/shield-lists-resources"},"pages":[{"title":"企業のShieldリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /shield_lists","description":"企業のすべてのShieldリストを取得します。","href":"/ja/reference/v2025.0/get-shield-lists"},{"title":"ShieldリストIDを指定して1つのShieldリストを取得","openapi":"box-openapi-v2025.0-jp.json GET /shield_lists/{shield_list_id}","description":"IDを指定して1つのShieldリストを取得します。","href":"/ja/reference/v2025.0/get-shield-lists-id"},{"title":"Shieldリストを作成","openapi":"box-openapi-v2025.0-jp.json POST /shield_lists","description":"Shieldリストを作成します。","href":"/ja/reference/v2025.0/post-shield-lists"},{"title":"Shieldリストを更新","openapi":"box-openapi-v2025.0-jp.json PUT /shield_lists/{shield_list_id}","description":"Shieldリストを更新します。","href":"/ja/reference/v2025.0/put-shield-lists-id"},{"title":"ShieldリストIDを指定して1つのShieldリストを削除","openapi":"box-openapi-v2025.0-jp.json DELETE /shield_lists/{shield_list_id}","description":"IDを指定して1つのShieldリストを削除します。","href":"/ja/reference/v2025.0/delete-shield-lists-id"}]}]},{"group":"v2026.0","pages":[{"group":"Automateワークフロー","tag":"Beta","pages":[{"title":"呼び出し可能なアクションとして定義されているAutomateワークフローのリストを取得","openapi":"box-openapi-v2026.0-jp.json GET /automate_workflows","tag":"Beta","description":"`WORKFLOW`アクションカテゴリを使用して、フォルダに対するAutomateからのワークフローのアクションを返します。","href":"/ja/reference/v2026.0/get-automate-workflows"},{"title":"Automateワークフローを開始","openapi":"box-openapi-v2026.0-jp.json POST /automate_workflows/{workflow_id}/start","tag":"Beta","description":"ワークフローのアクションIDとファイルIDを使用して、Automateワークフローを手動で開始します。","href":"/ja/reference/v2026.0/post-automate-workflows-id-start"}]},{"group":"Box Noteに変換","root":{"title":"Convert to Box note resources","description":null,"href":"/reference/v2026.0/notes-resources"},"pages":[{"title":"コンテンツをBox Noteに変換","openapi":"box-openapi-v2026.0-jp.json POST /notes/convert","description":"サポートされているソースコンテンツからBox Note (`.boxnote`ファイル) を作成します。サポートされている形式については、`content_format`フィールドを参照してください。","href":"/ja/reference/v2026.0/post-notes-convert"}]},{"group":"クエリ","root":{"title":"Query resources","description":null,"href":"/reference/v2026.0/query-resources"},"pages":[{"title":"Boxの項目に関するインサイトの作成","openapi":"box-openapi-v2026.0-jp.json POST /query_insights","description":"クエリの述語に一致するBoxの項目について集計指標を計算します。まずフィルタが適用され、次にグループ化 (省略可) が行われます。その後、作成されたグループごとに、またはフィルタ処理されたデータセット全体に対して、リクエストされた指標 (`sum`、`avg`、`min`、`max`、`count`など) が計算されます。","href":"/ja/reference/v2026.0/post-query-insights"},{"title":"Boxの項目に対するクエリ","openapi":"box-openapi-v2026.0-jp.json POST /query","description":"項目フィールドとメタデータテンプレートに対してフィルタをかけられる論理述語を使用して、Boxの項目を検出するクエリを実行します。結果は並べ替えたり、ページ割りしたりできるほか、追加の項目フィールドやメタデータフィールドを含む形式にすることができます。","href":"/ja/reference/v2026.0/post-query"}]}]}]},{"tab":"ツール","pages":[{"title":"ツール","href":"/ja/sdks-and-tools"}]},{"tab":"チュートリアル","pages":[{"title":"チュートリアル","href":"/ja/tutorials"}]},{"tab":"変更ログ","pages":[{"title":"変更ログ","href":"/ja/changelog/2026"}]}],"global":{"anchors":[{"anchor":"Box","icon":"https://mintlify.s3.us-west-1.amazonaws.com/box/images/sidebar/box.svg","href":"https://www.box.com/ja-jp/home"},{"anchor":"コミュニティ","icon":"book-open-cover","href":"https://community.box.com/box-platform-5?lang=ja"},{"anchor":"開発者向けブログ","icon":"newspaper","href":"https://medium.com/box-developer-japan-blog"},{"anchor":"Box SDKs","icon":"code","href":"https://github.com/box/sdks"},{"anchor":"Box Docs","icon":"file-lines","href":"https://docs.box.com"}]}}]},"title":"User avatars resources - Box Dev Docs","buildId":"dpl_33ETnXRdsYLr97cjMPs66KyshzXB","deploymentId":"dpl_33ETnXRdsYLr97cjMPs66KyshzXB","dynamics":["10e4515597"],"chunks":["BannerMarkdown-BKBpRG2E.js","dist-BEIpn4ri.js","lib-B6V4jynN.js","lib-vtHBCq3V.js","clsx-DhJ_U9w3.js","html-void-elements-mCSPHezU.js","katex-Cnv50rb0.js","marked.esm-BKo0Hl1x.js"]}