A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
{"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":"6ae079bd4d9226ccd8875f02","collectionId":"a720b092-6967-4302-962f-30fbf90b5d3d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae079bd4d9226ccd8875f02"},"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":"6ae079bd4d9226ccd8875f02","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"en","tag":"API reference","count":680},{"language":"ja","tag":"ホーム","count":368},{"language":"ja","tag":"APIリファレンス","count":339},{"language":"en","tag":"Home","count":302},{"language":"ja","tag":"AI","count":187},{"language":"en","tag":"AI","count":173},{"language":"ja","tag":"コラボレーション","count":81},{"language":"ja","tag":"ツール","count":76},{"language":"ja","tag":"開発ツール","count":76},{"language":"ja","tag":"メタデータと検索","count":67},{"language":"en","tag":"Tools","count":62},{"language":"en","tag":"Dev tools","count":62},{"language":"ja","tag":"コンテンツ","count":58},{"language":"en","tag":"Metadata \u0026 search","count":56},{"language":"en","tag":"Collaboration","count":50},{"language":"en","tag":"Content","count":49},{"language":"ja","tag":"メタデータ","count":49},{"language":"en","tag":"v2026.0","count":47},{"language":"en","tag":"Supported AI models","count":46},{"language":"ja","tag":"サポートされているAIモデル","count":44}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":true},"basePath":"","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":"workos-onboarding","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":"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":"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":"billing-page-v2","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":"fork-pr-previews","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":"vite-origin","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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","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/get-recent-items","slug":"/reference/get-recent-items","pageMetadata":{"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"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(Note,{children:[_jsxs(_components.p,{children:[`This endpoint is in the version `,_jsx(_components.strong,{children:`2024.0`}),`. No changes are required to continue using it. For more details, see `,_jsx(_components.strong,{children:_jsx(_components.a,{href:`/guides/api-calls/api-versioning-strategy`,children:`Box API versioning`})}),`.`]}),_jsxs(_components.p,{children:[`Learn more about `,_jsx(_components.a,{href:`/guides/tooling/sdks/sdk-versioning/`,children:`Box SDK versioning strategy`}),`.`]})]})}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":"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"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/box/523776d2eff70e58/scripts/cookie-banner.js","/_mintlify/custom/box/e597cec886c1778e/scripts/locale-links.js","/_mintlify/custom/box/37b2f846ed414abc/snippets/choose-choice-simple.js","/_mintlify/custom/box/78fc14bb599966cb/scripts/locale-footer-combined.js","/_mintlify/custom/box/9a429216167d598a/scripts/analitics.js","/_mintlify/custom/box/2f463a090bfcd0e8/snippets/boxIntl.js","/_mintlify/custom/box/d88c3906cf95ec86/snippets/translations.js","/_mintlify/custom/box/d67e74fc334b686a/scripts/preferred-source.js"],"openApiReferenceData":{"operation":{"operationId":"get_recent_items","summary":"List recently accessed 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.","parameters":["bb36c187-732f-4e35-ad3c-4c6c2eb0f909","244973ae-424e-4c97-af39-96c8837fad11","f841eccd-2f27-49d5-8a3a-9075ebbbb9ed"],"responses":{"200":"6ef4ba1a-481b-436c-bcc0-67cd94efc4f1","default":"cc698e0b-8829-4923-bec9-a0f011a7bdc0"},"x-box-tag":"recent_items","tags":["Recent items"],"x-codeSamples":[{"lang":"curl","label":"List recently accessed items","source":"curl -i -X GET \"https://api.box.com/2.0/recent_items\" \\\n -H \"authorization: Bearer \u003cACCESS_TOKEN>\""},{"lang":"dotnet","label":"List recently accessed items","source":"await client.RecentItems.GetRecentItemsAsync();"},{"lang":"swift","label":"List recently accessed items","source":"try await client.recentItems.getRecentItems()"},{"lang":"java","label":"List recently accessed items","source":"client.getRecentItems().getRecentItems()"},{"lang":"node","label":"List recently accessed items","source":"await client.recentItems.getRecentItems();"},{"lang":"python","label":"List recently accessed items","source":"client.recent_items.get_recent_items()"}],"method":"get","type":"path","servers":["8683cf83-a9de-408a-ab12-b8e2f203be5d"],"security":["df597f82-bd13-4225-8987-b23444140d5e"],"path":"/recent_items","baseUrlOptions":["https://api.box.com/2.0"],"title":"List recently accessed items","codeSamples":[{"label":"List recently accessed items","lang":"curl","source":"curl -i -X GET \"https://api.box.com/2.0/recent_items\" \\\n -H \"authorization: Bearer \u003cACCESS_TOKEN>\""},{"label":"List recently accessed items","lang":"dotnet","source":"await client.RecentItems.GetRecentItemsAsync();"},{"label":"List recently accessed items","lang":"swift","source":"try await client.recentItems.getRecentItems()"},{"label":"List recently accessed items","lang":"java","source":"client.getRecentItems().getRecentItems()"},{"label":"List recently accessed items","lang":"node","source":"await client.recentItems.getRecentItems();"},{"label":"List recently accessed items","lang":"python","source":"client.recent_items.get_recent_items()"}],"requestExampleLanguages":["bash","python","node","swift","java","dotnet"],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"bb36c187-732f-4e35-ad3c-4c6c2eb0f909":{"name":"fields","in":"query","description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.\n\nBe aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.","required":false,"schema":{"type":"array","items":{"type":"string","uniqueKey":"items.[INDEX]","typeLabel":"string"},"isRequired":false,"description":"A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.\n\nBe aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.","uniqueKey":"","typeLabel":"string[]"},"example":["id","type","name"],"explode":false},"244973ae-424e-4c97-af39-96c8837fad11":{"name":"limit","in":"query","description":"The maximum number of items to return per page.","required":false,"schema":{"type":"integer","format":"int64","maximum":1000,"isRequired":false,"description":"The maximum number of items to return per page.","uniqueKey":"","typeLabel":"integer\u003cint64>"},"example":1000},"f841eccd-2f27-49d5-8a3a-9075ebbbb9ed":{"name":"marker","in":"query","description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","required":false,"schema":{"type":"string","isRequired":false,"description":"Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.","uniqueKey":"","typeLabel":"string"},"example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"}},"responses":{"6ef4ba1a-481b-436c-bcc0-67cd94efc4f1":{"description":"Returns a list recent items access by a user.","content":{"application/json":{"schema":{"type":"object","title":"Recent items","description":"A list of recent items.","x-box-resource-id":"recent_items","properties":{"limit":{"description":"The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.","type":"integer","format":"int64","example":1000,"uniqueKey":"limit","typeLabel":"integer\u003cint64>"},"next_marker":{"oneOf":[{"description":"The marker for the start of the next page of results.","type":"string","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","uniqueKey":"next_marker.oneOf.0","typeLabel":"string"},{"description":"The marker for the start of the next page of results.","type":"null","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","uniqueKey":"next_marker.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_marker","typeLabel":"string | null"},"prev_marker":{"oneOf":[{"description":"The marker for the start of the previous page of results.","type":"string","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","uniqueKey":"prev_marker.oneOf.0","typeLabel":"string"},{"description":"The marker for the start of the previous page of results.","type":"null","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","uniqueKey":"prev_marker.oneOf.1","typeLabel":"null"}],"uniqueKey":"prev_marker","typeLabel":"string | null"},"entries":{"description":"A list of recent items.","type":"array","items":{"description":"A recent item accessed by a user.","type":"object","properties":{"type":{"description":"The value will always be `recent_item`.","type":"string","example":"recent_item","uniqueKey":"entries.items.[INDEX].type","typeLabel":"string"},"item":{"oneOf":[{"type":"object","title":"File (Full)","description":"The item that was recently accessed.","required":["id","type"],"x-box-resource-id":"file--full","x-box-tag":"files","x-box-variant":"full","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a file.\n\nThe ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.id","typeLabel":"string"},"type":{"description":"The value will always be `file`.","type":"string","example":"file","enum":["file"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the file.","type":"string","example":"Contract.pdf","uniqueKey":"entries.items.[INDEX].item.oneOf.0.name","typeLabel":"string"},"sha1":{"description":"The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.","type":"string","format":"digest","example":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.sha1","typeLabel":"string\u003cdigest>"},"file_version":{"type":"object","title":"File version (Mini)","description":"The information about the current version of the file.","required":["id","type"],"x-box-resource-id":"file_version--mini","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a file version.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.file_version.id","typeLabel":"string"},"type":{"description":"The value will always be `file_version`.","type":"string","example":"file_version","enum":["file_version"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.file_version.type","typeLabel":"enum\u003cstring>"},"sha1":{"description":"The SHA1 hash of this version of the file.","type":"string","example":"134b65991ed521fcfe4724b7d814ab8ded5185dc","uniqueKey":"entries.items.[INDEX].item.oneOf.0.file_version.sha1","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.file_version","typeLabel":"File version (Mini) · object"},"description":{"description":"The optional description of this file. If the description exceeds 255 characters, the first 255 characters are set as a file description and the rest of it is ignored.","type":"string","example":"Contract for Q1 renewal","maxLength":255,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.description","typeLabel":"string"},"size":{"description":"The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.","type":"integer","example":629644,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.size","typeLabel":"integer"},"path_collection":{"type":"object","title":"Path collection","description":"The tree of folders that this file is contained in, starting at the root.","required":["total_count","entries"],"properties":{"total_count":{"description":"The number of folders in this list.","type":"integer","format":"int64","example":1,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.total_count","typeLabel":"integer\u003cint64>"},"entries":{"description":"The parent folders for this item.","type":"array","items":{"type":"object","title":"Folder (Mini)","description":"A mini representation of a file version, used when nested under another resource.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries.items.[INDEX]","typeLabel":"Folder (Mini) · object"},"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection.entries","typeLabel":"Folder (Mini) · object[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.path_collection","typeLabel":"Path collection · object"},"created_at":{"description":"The date and time when the file was created on Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"description":"The date and time when the file was last updated on Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.modified_at","typeLabel":"string\u003cdate-time>"},"trashed_at":{"oneOf":[{"description":"The time at which this file was put in the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.trashed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The time at which this file was put in the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.trashed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.trashed_at","typeLabel":"string\u003cdate-time> | null"},"purged_at":{"oneOf":[{"description":"The time at which this file is expected to be purged from the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.purged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The time at which this file is expected to be purged from the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.purged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.purged_at","typeLabel":"string\u003cdate-time> | null"},"content_created_at":{"oneOf":[{"description":"The date and time at which this file was originally created, which might be before it was uploaded to Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.content_created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time at which this file was originally created, which might be before it was uploaded to Box.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.content_created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.content_created_at","typeLabel":"string\u003cdate-time> | null"},"content_modified_at":{"oneOf":[{"description":"The date and time at which this file was last updated, which might be before it was uploaded to Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.content_modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time at which this file was last updated, which might be before it was uploaded to Box.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.content_modified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.content_modified_at","typeLabel":"string\u003cdate-time> | null"},"created_by":{"type":"object","title":"User (Mini)","description":"The user who created this file.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.created_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.created_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.created_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.created_by","typeLabel":"User (Mini) · object"},"modified_by":{"type":"object","title":"User (Mini)","description":"The user who last modified this file.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.modified_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.modified_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.modified_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.modified_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.modified_by","typeLabel":"User (Mini) · object"},"owned_by":{"type":"object","title":"User (Mini)","description":"The user who owns this file.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.owned_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.owned_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.owned_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.owned_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.owned_by","typeLabel":"User (Mini) · object"},"shared_link":{"oneOf":[{"type":"object","title":"Shared link","description":"The shared link for this file. This value will be `null` if no shared link has been created for this file.","required":["url","accessed","effective_access","effective_permission","is_password_enabled","download_count","preview_count","one_time_passcode"],"properties":{"url":{"description":"The URL that can be used to access the item on Box.\n\nThis URL will display the item in Box's preview UI where the file can be downloaded if allowed.\n\nThis URL will continue to work even when a custom `vanity_url` has been set for this shared link.","type":"string","format":"url","example":"https://www.box.com/s/vspke7y05sb214wjokpk","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.url","typeLabel":"string\u003curl>"},"effective_access":{"description":"The effective access level for the shared link. This can be a more restrictive access level than the value in the `access` field when the enterprise settings restrict the allowed access levels.","type":"string","example":"company","enum":["open","company","collaborators"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.effective_access","typeLabel":"enum\u003cstring>"},"effective_permission":{"description":"The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder.","type":"string","example":"can_download","enum":["can_edit","can_download","can_preview","no_access"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.effective_permission","typeLabel":"enum\u003cstring>"},"is_password_enabled":{"description":"Defines if the shared link requires a password to access the item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.is_password_enabled","typeLabel":"boolean"},"download_count":{"description":"The number of times this item has been downloaded.","type":"integer","example":3,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.download_count","typeLabel":"integer"},"preview_count":{"description":"The number of times this item has been previewed.","type":"integer","example":3,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.preview_count","typeLabel":"integer"},"one_time_passcode":{"type":"object","title":"Shared link OTP settings","description":"The one-time-passcode (OTP) settings for this shared link.\n\nThis field is always present. For links where OTP does not apply (for example, shared links whose `access` is not `open`), the object is returned with `mode` set to `none`.","required":["mode"],"properties":{"mode":{"description":"The current OTP enforcement mode for the shared link.\n\n- `none` - OTP enforcement is turned off. The shared link is accessible without any one-time-passcode verification.\n- `open` - Any anonymous recipient can request a one-time-passcode to any email address and access the shared link after verifying it. Collaborators and registered Box users access the link without being prompted.\n- `allowlist` - Anonymous recipients can request a one-time-passcode only when they enter an email that matches an entry on the `allowlist`.","type":"string","example":"allowlist","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.mode","typeLabel":"string"},"allowlist":{"description":"The list of email and domain entries that are permitted to access the shared link when `mode` is `allowlist`. Anonymous users whose email matches an entry can request and verify a one-time-passcode.\n\nBecause the entries carry recipient email addresses and the identity of the user who added them, this field is only returned to users with owner, co-owner, or editor access on the item. For viewer collaborators and below the field is omitted.\n\nAn allowlist contains at most 1000 entries, matching the limit enforced when setting the allowlist on a shared link.","type":"array","items":{"description":"An entry on the OTP allowlist for a shared link. The entry can match either a specific email address or every email address that belongs to a domain.","type":"object","properties":{"type":{"description":"The kind of allowlist entry.\n\n- `email` - The entry matches a single email address.\n- `domain` - The entry matches every email address under the given domain.","type":"string","example":"email","enum":["email","domain"],"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"The value of the allowlist entry.\n\n- For `email` entries, the full email address (must contain `@`).\n- For `domain` entries, the bare domain (e.g. `example.com`).","type":"string","example":"alice@example.com","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].value","typeLabel":"string"},"created_at":{"description":"The date and time when the allowlist entry was added.","type":"string","format":"date-time","example":"2026-05-19T12:00:00Z","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"object","title":"User (Base)","description":"User who added this entry.","required":["type","id"],"x-box-resource-id":"user--base","x-box-tag":"users","x-box-variant":"base","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by","typeLabel":"User (Base) · object"}},"required":["type","value","created_at","created_by"],"title":"Shared link OTP allowlist entry","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX]","typeLabel":"Shared link OTP allowlist entry · object"},"example":[{"type":"email","value":"alice@example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}},{"type":"domain","value":"example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}}],"maxItems":1000,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode.allowlist","typeLabel":"Shared link OTP allowlist entry · object[]"}},"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.one_time_passcode","typeLabel":"Shared link OTP settings · object"},"download_url":{"oneOf":[{"description":"A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.","type":"string","format":"url","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","x-box-premium-feature":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.download_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.","type":"null","format":"url","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","x-box-premium-feature":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.download_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.download_url","typeLabel":"string\u003curl> | null"},"vanity_url":{"oneOf":[{"description":"The \"Custom URL\" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.","type":"string","format":"url","example":"https://acme.app.box.com/v/my_url/","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.vanity_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"The \"Custom URL\" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.","type":"null","format":"url","example":"https://acme.app.box.com/v/my_url/","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.vanity_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.vanity_url","typeLabel":"string\u003curl> | null"},"vanity_name":{"oneOf":[{"description":"The custom name of a shared link, as used in the `vanity_url` field.","type":"string","example":"my_url","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.vanity_name.oneOf.0","typeLabel":"string"},{"description":"The custom name of a shared link, as used in the `vanity_url` field.","type":"null","example":"my_url","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.vanity_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.vanity_name","typeLabel":"string | null"},"access":{"description":"The access level for this shared link.\n\n- `open` - provides access to this item to anyone with this link\n- `company` - only provides access to this item to people the same company\n- `collaborators` - only provides access to this item to people who are collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin.","type":"string","example":"open","enum":["open","company","collaborators"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.access","typeLabel":"enum\u003cstring>"},"unshared_at":{"oneOf":[{"description":"The date and time when this link will be unshared. This field can only be set by users with paid accounts.","type":"string","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.unshared_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time when this link will be unshared. This field can only be set by users with paid accounts.","type":"null","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.unshared_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.unshared_at","typeLabel":"string\u003cdate-time> | null"},"permissions":{"description":"Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself.","type":"object","properties":{"can_download":{"description":"Defines if the shared link allows for the item to be downloaded. For shared links on folders, this also applies to any items in the folder.\n\nThis value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.permissions.can_download","typeLabel":"boolean"},"can_preview":{"description":"Defines if the shared link allows for the item to be previewed.\n\nThis value is always `true`. For shared links on folders this also applies to any items in the folder.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.permissions.can_preview","typeLabel":"boolean"},"can_edit":{"description":"Defines if the shared link allows for the item to be edited.\n\nThis value can only be `true` if `can_download` is also `true` and if the item has a type of `file`.","type":"boolean","example":false,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.permissions.can_edit","typeLabel":"boolean"}},"required":["can_download","can_preview","can_edit"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0.permissions","typeLabel":"object"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.0","typeLabel":"Shared link · object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link","typeLabel":"Shared link · object | null"},"parent":{"oneOf":[{"type":"object","title":"Folder (Mini)","description":"The folder that this file is located within. This value may be `null` for some folders such as the root folder or the trash folder.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.0","typeLabel":"Folder (Mini) · object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.parent","typeLabel":"Folder (Mini) · object | null"},"item_status":{"description":"Defines if this item has been deleted or not.\n\n- `active` when the item has is not in the trash\n- `trashed` when the item has been moved to the trash but not deleted\n- `deleted` when the item has been permanently deleted.","type":"string","example":"active","enum":["active","trashed","deleted"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.item_status","typeLabel":"enum\u003cstring>"},"version_number":{"description":"The version number of this file.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.version_number","typeLabel":"string"},"comment_count":{"description":"The number of comments on this file.","type":"integer","example":10,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.comment_count","typeLabel":"integer"},"permissions":{"type":"object","description":"Describes the permissions that the current user has for this file.","required":["can_annotate","can_comment","can_preview","can_upload","can_view_annotations_all","can_view_annotations_self","can_delete","can_download","can_invite_collaborator","can_rename","can_set_share_access","can_share"],"properties":{"can_delete":{"description":"Specifies if the current user can delete this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_delete","typeLabel":"boolean"},"can_download":{"description":"Specifies if the current user can download this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_download","typeLabel":"boolean"},"can_invite_collaborator":{"description":"Specifies if the current user can invite new users to collaborate on this item, and if the user can update the role of a user already collaborated on this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_invite_collaborator","typeLabel":"boolean"},"can_rename":{"description":"Specifies if the user can rename this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_rename","typeLabel":"boolean"},"can_set_share_access":{"description":"Specifies if the user can change the access level of an existing shared link on this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_set_share_access","typeLabel":"boolean"},"can_share":{"description":"Specifies if the user can create a shared link for this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_share","typeLabel":"boolean"},"can_annotate":{"description":"Specifies if the user can place annotations on this file.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_annotate","typeLabel":"boolean"},"can_comment":{"description":"Specifies if the user can place comments on this file.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_comment","typeLabel":"boolean"},"can_preview":{"description":"Specifies if the user can preview this file.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_preview","typeLabel":"boolean"},"can_upload":{"description":"Specifies if the user can upload a new version of this file.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_upload","typeLabel":"boolean"},"can_view_annotations_all":{"description":"Specifies if the user view all annotations placed on this file.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_view_annotations_all","typeLabel":"boolean"},"can_view_annotations_self":{"description":"Specifies if the user view annotations placed by themselves on this file.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_view_annotations_self","typeLabel":"boolean"},"can_apply_watermark":{"description":"Specifies if the user can apply a watermark to this file.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions.can_apply_watermark","typeLabel":"boolean"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.permissions","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"entries.items.[INDEX].item.oneOf.0.tags.items.[INDEX]","typeLabel":"string"},"description":"The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.\n\nTo add or remove a tag, retrieve the item's current tags, modify them, and then update this field.\n\nThere is a limit of 100 tags per item, and 10,000 unique tags per enterprise.","maxItems":100,"minItems":1,"example":["approved"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.tags","typeLabel":"string[]"},"lock":{"oneOf":[{"type":"object","title":"Lock","description":"The lock held on this file. If there is no lock, this can either be `null` or have a timestamp in the past.","properties":{"id":{"description":"The unique identifier for this lock.","type":"string","example":"11446498","uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.id","typeLabel":"string"},"type":{"description":"The value will always be `lock`.","type":"string","example":"lock","enum":["lock"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.type","typeLabel":"enum\u003cstring>"},"created_by":{"type":"object","title":"User (Mini)","description":"The user who created the lock.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.created_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.created_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.created_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.created_by","typeLabel":"User (Mini) · object"},"created_at":{"description":"The time this lock was created at.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"expired_at":{"description":"The time this lock is to expire at, which might be in the past.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.expired_at","typeLabel":"string\u003cdate-time>"},"is_download_prevented":{"description":"Whether or not the file can be downloaded while locked.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.is_download_prevented","typeLabel":"boolean"},"app_type":{"oneOf":[{"description":"If the lock is managed by an application rather than a user, this field identifies the type of the application that holds the lock. This is an open enum and may be extended with additional values in the future.","type":"string","example":"office_wopiplus","enum":["gsuite","office_wopi","office_wopiplus","other"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.app_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"If the lock is managed by an application rather than a user, this field identifies the type of the application that holds the lock. This is an open enum and may be extended with additional values in the future.","type":"null","example":"office_wopiplus","enum":["gsuite","office_wopi","office_wopiplus","other"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.app_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0.app_type","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.0","typeLabel":"Lock · object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.lock","typeLabel":"Lock · object | null"},"extension":{"description":"Indicates the (optional) file extension for this file. By default, this is set to an empty string.","type":"string","example":"pdf","uniqueKey":"entries.items.[INDEX].item.oneOf.0.extension","typeLabel":"string"},"is_package":{"description":"Indicates if the file is a package. Packages are commonly used by Mac Applications and can include iWork files.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.is_package","typeLabel":"boolean"},"expiring_embed_link":{"type":"object","title":"Expiring embed link","description":"Requesting this field creates an expiring Box Embed URL for an embedded preview session in an `iframe`.\n\nThis URL will expire after 60 seconds and the session will expire after 60 minutes.\n\nNot all file types are supported for these embed URLs. Box Embed is not optimized for mobile browsers and should not be used in web experiences designed for mobile devices. Many UI elements, like the **download** and **print** options might not show in mobile browsers.","properties":{"access_token":{"description":"The requested access token.","type":"string","format":"token","example":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.access_token","typeLabel":"string\u003ctoken>"},"expires_in":{"description":"The time in seconds by which this token will expire.","type":"integer","format":"int64","example":3600,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.expires_in","typeLabel":"integer\u003cint64>"},"token_type":{"description":"The type of access token returned.","type":"string","example":"bearer","enum":["bearer"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.token_type","typeLabel":"enum\u003cstring>"},"restricted_to":{"description":"The permissions that this access token permits, providing a list of resources (files, folders, etc) and the scopes permitted for each of those resources.","type":"array","items":{"description":"A relation between a resource (file or folder) and the scopes for which the resource can be accessed.","type":"object","properties":{"scope":{"description":"The scopes for the resource access.","type":"string","example":"item_download","enum":["annotation_edit","annotation_view_all","annotation_view_self","base_explorer","base_picker","base_preview","base_upload","item_delete","item_download","item_preview","item_rename","item_share","item_upload","item_read"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].scope","typeLabel":"enum\u003cstring>"},"object":{"oneOf":[{"type":"object","title":"Folder (Mini)","description":"A mini representation of a file version, used when nested under another resource.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.0","typeLabel":"Folder (Mini) · object"},{"type":"object","title":"File (Mini)","description":"A mini representation of a file, used when nested under another resource.","required":["id","type"],"x-box-resource-id":"file--mini","x-box-tag":"files","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a file.\n\nThe ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.id","typeLabel":"string"},"type":{"description":"The value will always be `file`.","type":"string","example":"file","enum":["file"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the file.","type":"string","example":"Contract.pdf","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.name","typeLabel":"string"},"sha1":{"description":"The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.","type":"string","format":"digest","example":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.sha1","typeLabel":"string\u003cdigest>"},"file_version":{"type":"object","title":"File version (Mini)","description":"The information about the current version of the file.","required":["id","type"],"x-box-resource-id":"file_version--mini","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a file version.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.file_version.id","typeLabel":"string"},"type":{"description":"The value will always be `file_version`.","type":"string","example":"file_version","enum":["file_version"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.file_version.type","typeLabel":"enum\u003cstring>"},"sha1":{"description":"The SHA1 hash of this version of the file.","type":"string","example":"134b65991ed521fcfe4724b7d814ab8ded5185dc","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.file_version.sha1","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1.file_version","typeLabel":"File version (Mini) · object"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object.oneOf.1","typeLabel":"File (Mini) · object"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX].object","typeLabel":"Folder (Mini) · object | File (Mini) · object"}},"title":"Resource scope","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to.items.[INDEX]","typeLabel":"Resource scope · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.restricted_to","typeLabel":"Resource scope · object[]"},"url":{"description":"The actual expiring embed URL for this file, constructed from the file ID and access tokens specified in this object.","type":"string","format":"url","example":"https://cloud.app.box.com/preview/expiring_embed/...","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link.url","typeLabel":"string\u003curl>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expiring_embed_link","typeLabel":"Expiring embed link · object"},"watermark_info":{"type":"object","description":"Details about the watermark applied to this file.","properties":{"is_watermarked":{"description":"Specifies if this item has a watermark applied.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.watermark_info.is_watermarked","typeLabel":"boolean"},"is_watermark_inherited":{"description":"Specifies if the watermark is inherited from any parent folder in the hierarchy.","type":"boolean","example":false,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.watermark_info.is_watermark_inherited","typeLabel":"boolean"},"is_watermarked_by_access_policy":{"description":"Specifies if the watermark is enforced by an access policy.","type":"boolean","example":false,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.watermark_info.is_watermarked_by_access_policy","typeLabel":"boolean"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.watermark_info","typeLabel":"object"},"is_accessible_via_shared_link":{"description":"Specifies if the file can be accessed via the direct shared link or a shared link to a parent folder.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.is_accessible_via_shared_link","typeLabel":"boolean"},"allowed_invitee_roles":{"description":"A list of the types of roles that user can be invited at when sharing this file.","type":"array","items":{"type":"string","enum":["editor","viewer","previewer","uploader","previewer uploader","viewer uploader","co-owner"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.allowed_invitee_roles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["editor"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.allowed_invitee_roles","typeLabel":"enum\u003cstring>[]"},"is_externally_owned":{"description":"Specifies if this file is owned by a user outside of the authenticated enterprise.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.is_externally_owned","typeLabel":"boolean"},"has_collaborations":{"description":"Specifies if this file has any other collaborators.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.has_collaborations","typeLabel":"boolean"},"metadata":{"type":"object","title":"Item metadata instances","description":"An object containing the metadata instances that have been attached to this file.\n\nEach metadata instance is uniquely identified by its `scope` and `templateKey`. There can only be one instance of any metadata template attached to each file. Each metadata instance is nested within an object with the `templateKey` as the key, which again itself is nested in an object with the `scope` as the key.","example":{"enterprise_27335":{"marketingCollateral":{"$canEdit":true,"$id":"01234500-12f1-1234-aa12-b1d234cb567e","$parent":"folder_59449484661","$scope":"enterprise_27335","$template":"marketingCollateral","$type":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","$typeVersion":2,"$version":1}}},"additionalProperties":{"type":"object","description":"A list of metadata instances, nested within key-value pairs of their `scope` and `templateKey`.","example":{"marketingCollateral":{"$canEdit":true,"$id":"01234500-12f1-1234-aa12-b1d234cb567e","$parent":"folder_59449484661","$scope":"enterprise_27335","$template":"marketingCollateral","$type":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","$typeVersion":2,"$version":1}},"additionalProperties":{"type":"object","title":"Metadata instance (Full)","description":"An instance of a metadata template, which has been applied to a file or folder.","x-box-resource-id":"metadata--full","x-box-tag":"file_metadata","x-box-variant":"full","x-box-variants":["base","standard","full"],"properties":{"$parent":{"description":"The identifier of the item that this metadata instance has been attached to. This combines the `type` and the `id` of the parent in the form `{type}_{id}`.","type":"string","example":"folder_59449484661,","uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$parent","typeLabel":"string"},"$template":{"description":"The name of the template.","type":"string","example":"marketingCollateral","uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$template","typeLabel":"string"},"$scope":{"description":"An ID for the scope in which this template has been applied. This will be `enterprise_{enterprise_id}` for templates defined for use in this enterprise, and `global` for general templates that are available to all enterprises using Box.","type":"string","example":"enterprise_27335","uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$scope","typeLabel":"string"},"$version":{"description":"The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.","type":"integer","example":1,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$version","typeLabel":"integer"},"$canEdit":{"description":"Whether the user can edit this metadata instance.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$canEdit","typeLabel":"boolean"},"$id":{"description":"A UUID to identify the metadata instance.","type":"string","format":"uuid","example":"01234500-12f1-1234-aa12-b1d234cb567e","maxLength":36,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$id","typeLabel":"string\u003cuuid>"},"$type":{"description":"A unique identifier for the \"type\" of this instance. This is an internal system property and should not be used by a client application.","type":"string","example":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$type","typeLabel":"string"},"$typeVersion":{"description":"The last-known version of the template of the object. This is an internal system property and should not be used by a client application.","type":"integer","example":2,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.$typeVersion","typeLabel":"integer"}},"additionalProperties":{"description":"A value for each of the fields that are present on the metadata template. For the `global.properties` template this can be a list of zero or more fields, as this template allows for any generic key-value pairs to be stored stored in the template.","x-box-example-key":"name","example":"Aaron Levie","uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties.additionalProperties","typeLabel":"any"},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties.additionalProperties","typeLabel":"Metadata instance (Full) · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata.additionalProperties","typeLabel":"object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.metadata","typeLabel":"Item metadata instances · object"},"expires_at":{"oneOf":[{"description":"When the file will automatically be deleted.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the file will automatically be deleted.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"representations":{"type":"object","title":"Representations","description":"A list of representations for a file that can be used to display a placeholder of the file in your application. By default this returns all representations and we recommend using the `x-rep-hints` header to further customize the desired representations.","properties":{"entries":{"description":"A list of files.","type":"array","items":{"type":"object","description":"A file representation.","properties":{"content":{"description":"An object containing the URL that can be used to actually fetch the representation.","properties":{"url_template":{"description":"The download URL that can be used to fetch the representation. Make sure to make an authenticated API call to this endpoint.\n\nThis URL is a template and will require the `{+asset_path}` to be replaced by a path. In general, for unpaged representations it can be replaced by an empty string.\n\nFor paged representations, replace the `{+asset_path}` with the page to request plus the extension for the file, for example `1.pdf`.\n\nWhen requesting the download URL the following additional query params can be passed along.\n\n- `set_content_disposition_type` - Sets the `Content-Disposition` header in the API response with the specified disposition type of either `inline` or `attachment`. If not supplied, the `Content-Disposition` header is not included in the response.\n\n- `set_content_disposition_filename` - Allows the application to define the representation's file name used in the `Content-Disposition` header. If not defined, the filename is derived from the source file name in Box combined with the extension of the representation.","type":"string","example":"https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].content.url_template","typeLabel":"string"}},"type":"object","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].content","typeLabel":"object"},"info":{"description":"An object containing the URL that can be used to fetch more info on this representation.","type":"object","properties":{"url":{"description":"The API URL that can be used to get more info on this file representation. Make sure to make an authenticated API call to this endpoint.","type":"string","example":"https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].info.url","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].info","typeLabel":"object"},"properties":{"description":"An object containing the size and type of this presentation.","type":"object","properties":{"dimensions":{"type":"string","format":"\u003cwidth>x\u003cheight>","example":"2048x2048","description":"The width by height size of this representation in pixels.","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].properties.dimensions","typeLabel":"string\u003c\u003cwidth>x\u003cheight>>"},"paged":{"type":"string","example":"true","description":"Indicates if the representation is build up out of multiple pages.","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].properties.paged","typeLabel":"string"},"thumb":{"type":"string","example":"true","description":"Indicates if the representation can be used as a thumbnail of the file.","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].properties.thumb","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].properties","typeLabel":"object"},"representation":{"description":"Indicates the file type of the returned representation.","type":"string","example":"png","uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].representation","typeLabel":"string"},"status":{"description":"An object containing the status of this representation.","type":"object","properties":{"state":{"description":"The status of the representation.\n\n- `success` defines the representation as ready to be viewed.\n- `viewable` defines a video to be ready for viewing.\n- `pending` defines the representation as to be generated. Retry this endpoint to re-check the status.\n- `none` defines that the representation will be created when requested. Request the URL defined in the `info` object to trigger this generation.","type":"string","example":"success","enum":["success","viewable","pending","none"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].status.state","typeLabel":"enum\u003cstring>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX].status","typeLabel":"object"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations.entries","typeLabel":"object[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.representations","typeLabel":"Representations · object"},"classification":{"oneOf":[{"type":"object","description":"Details about the classification applied to this file.","properties":{"name":{"description":"The name of the classification.","type":"string","example":"Top Secret","uniqueKey":"entries.items.[INDEX].item.oneOf.0.classification.oneOf.0.name","typeLabel":"string"},"definition":{"description":"An explanation of the meaning of this classification.","type":"string","example":"Content that should not be shared outside the company.","uniqueKey":"entries.items.[INDEX].item.oneOf.0.classification.oneOf.0.definition","typeLabel":"string"},"color":{"description":"The color that is used to display the classification label in a user-interface. Colors are defined by the admin or co-admin who created the classification in the Box web app.","type":"string","example":"#FF0000","uniqueKey":"entries.items.[INDEX].item.oneOf.0.classification.oneOf.0.color","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.classification.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.0.classification.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.classification","typeLabel":"object | null"},"uploader_display_name":{"type":"string","title":"Uploader display name","description":"The display name of the user that uploaded the file. In most cases this is the name of the user logged in at the time of the upload.\n\nIf the file was uploaded using a File Request form that requires the user to provide an email address, this field is populated with that email address. If an email address was not required in the File Request form, this field is set to return a value of `File Request`.\n\nIn all other anonymous cases where no email was provided this field will default to a value of `Someone`.","example":"Ellis Wiggins","uniqueKey":"entries.items.[INDEX].item.oneOf.0.uploader_display_name","typeLabel":"string"},"disposition_at":{"oneOf":[{"description":"The retention expiration timestamp for the given file.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.disposition_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The retention expiration timestamp for the given file.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.0.disposition_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.disposition_at","typeLabel":"string\u003cdate-time> | null"},"shared_link_permission_options":{"oneOf":[{"description":"A list of the types of roles that user can be invited at when sharing this file.","type":"array","items":{"type":"string","enum":["can_preview","can_download","can_edit"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link_permission_options.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["can_preview"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link_permission_options.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"A list of the types of roles that user can be invited at when sharing this file.","type":"null","items":{"type":"string","enum":["can_preview","can_download","can_edit"]},"example":["can_preview"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link_permission_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.shared_link_permission_options","typeLabel":"enum\u003cstring>[] | null"},"is_associated_with_app_item":{"description":"This field will return true if the file or any ancestor of the file is associated with at least one app item. Note that this will return true even if the context user does not have access to the app item(s) associated with the file.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.is_associated_with_app_item","typeLabel":"boolean"},"collections":{"description":"The collections that this file belongs to.\n\nFor more information, see the [collections guide](/guides/collections).","type":"array","items":{"description":"A collection of items, including files and folders.\n\nCurrently, the only collection available is the `favorites` collection.\n\nThe contents of a collection can be explored in a similar way to which the contents of a folder is explored.","type":"object","properties":{"id":{"description":"The unique identifier for this collection.","type":"string","example":"11446498","uniqueKey":"entries.items.[INDEX].item.oneOf.0.collections.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `collection`.","type":"string","example":"collection","enum":["collection"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.collections.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"description":"The name of the collection.","type":"string","example":"Favorites","enum":["Favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.collections.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"collection_type":{"description":"The type of the collection. This is used to determine the proper visual treatment for collections.","type":"string","example":"favorites","enum":["favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.collections.items.[INDEX].collection_type","typeLabel":"enum\u003cstring>"}},"title":"Collection","x-box-resource-id":"collection","x-box-tag":"collections","uniqueKey":"entries.items.[INDEX].item.oneOf.0.collections.items.[INDEX]","typeLabel":"Collection · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.0.collections","typeLabel":"Collection · object[]"},"is_download_available":{"description":"Whether the file's binary content is eligible to be downloaded.\n\nThis is a content-level flag and does not reflect whether the current user is authorized to download the file. Use `permissions.can_download`, when available, for that.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.is_download_available","typeLabel":"boolean"},"download_url":{"description":"A pre-authorized, expiring URL for directly downloading the file's content. Requires authentication and is valid only for the current session.\n\nThis field is only returned for files, not folders or web links.","type":"string","format":"url","example":"https://dl.boxcloud.com/d/1/example_token/download","uniqueKey":"entries.items.[INDEX].item.oneOf.0.download_url","typeLabel":"string\u003curl>"},"authenticated_download_url":{"description":"A stable API URL for the file content endpoint, `/2.0/files/{id}/content`. Unlike `download_url`, authorization is evaluated when the URL is requested with a valid access token.\n\nThis field is only returned for files, not folders or web links.","type":"string","format":"url","example":"https://api.box.com/2.0/files/12345/content","uniqueKey":"entries.items.[INDEX].item.oneOf.0.authenticated_download_url","typeLabel":"string\u003curl>"},"allowed_shared_link_access_levels":{"description":"The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this file.\n\nThe list depends on item policy and user authorization, so it may be narrower than the levels available to the owner. An empty array means no access level is available to this user.","type":"array","items":{"title":"Shared link access level","type":"string","description":"The access level for a shared link.","example":"open","enum":["open","company","collaborators"],"uniqueKey":"entries.items.[INDEX].item.oneOf.0.allowed_shared_link_access_levels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["open"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.0.allowed_shared_link_access_levels","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.0","typeLabel":"File (Full) · object"},{"type":"object","title":"Folder (Full)","description":"The item that was recently accessed.","required":["id","type"],"x-box-resource-id":"folder--full","x-box-tag":"folders","x-box-variant":"full","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.1.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.1.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.name","typeLabel":"string"},"created_at":{"oneOf":[{"description":"The date and time when the folder was created. This value may be `null` for some folders such as the root folder or the trash folder.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time when the folder was created. This value may be `null` for some folders such as the root folder or the trash folder.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_at","typeLabel":"string\u003cdate-time> | null"},"modified_at":{"oneOf":[{"description":"The date and time when the folder was last updated. This value may be `null` for some folders such as the root folder or the trash folder.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time when the folder was last updated. This value may be `null` for some folders such as the root folder or the trash folder.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_at","typeLabel":"string\u003cdate-time> | null"},"description":{"type":"string","description":"The optional description of this folder.","maxLength":256,"example":"Legal contracts for the new ACME deal","uniqueKey":"entries.items.[INDEX].item.oneOf.1.description","typeLabel":"string"},"size":{"description":"The folder size in bytes.\n\nBe careful parsing this integer as its value can get very large.","type":"integer","format":"int64","example":629644,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.size","typeLabel":"integer\u003cint64>"},"path_collection":{"type":"object","title":"Path collection","description":"The tree of folders that this folder is contained in, starting at the root.","required":["total_count","entries"],"properties":{"total_count":{"description":"The number of folders in this list.","type":"integer","format":"int64","example":1,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.total_count","typeLabel":"integer\u003cint64>"},"entries":{"description":"The parent folders for this item.","type":"array","items":{"type":"object","title":"Folder (Mini)","description":"A mini representation of a file version, used when nested under another resource.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries.items.[INDEX]","typeLabel":"Folder (Mini) · object"},"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection.entries","typeLabel":"Folder (Mini) · object[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.path_collection","typeLabel":"Path collection · object"},"created_by":{"type":"object","title":"User (Mini)","description":"The user who created this folder.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.created_by","typeLabel":"User (Mini) · object"},"modified_by":{"type":"object","title":"User (Mini)","description":"The user who last modified this folder.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.modified_by","typeLabel":"User (Mini) · object"},"trashed_at":{"oneOf":[{"description":"The time at which this folder was put in the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.trashed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The time at which this folder was put in the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.trashed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.trashed_at","typeLabel":"string\u003cdate-time> | null"},"purged_at":{"oneOf":[{"description":"The time at which this folder is expected to be purged from the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.purged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The time at which this folder is expected to be purged from the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.purged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.purged_at","typeLabel":"string\u003cdate-time> | null"},"content_created_at":{"oneOf":[{"description":"The date and time at which this folder was originally created.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.content_created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time at which this folder was originally created.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.content_created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.content_created_at","typeLabel":"string\u003cdate-time> | null"},"content_modified_at":{"oneOf":[{"description":"The date and time at which this folder was last updated.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.content_modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time at which this folder was last updated.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.content_modified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.content_modified_at","typeLabel":"string\u003cdate-time> | null"},"owned_by":{"type":"object","title":"User (Mini)","description":"The user who owns this folder.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.owned_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.owned_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.owned_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.owned_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.owned_by","typeLabel":"User (Mini) · object"},"shared_link":{"oneOf":[{"type":"object","title":"Shared link","description":"The shared link for this folder. This will be `null` if no shared link has been created for this folder.","required":["url","accessed","effective_access","effective_permission","is_password_enabled","download_count","preview_count","one_time_passcode"],"properties":{"url":{"description":"The URL that can be used to access the item on Box.\n\nThis URL will display the item in Box's preview UI where the file can be downloaded if allowed.\n\nThis URL will continue to work even when a custom `vanity_url` has been set for this shared link.","type":"string","format":"url","example":"https://www.box.com/s/vspke7y05sb214wjokpk","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.url","typeLabel":"string\u003curl>"},"effective_access":{"description":"The effective access level for the shared link. This can be a more restrictive access level than the value in the `access` field when the enterprise settings restrict the allowed access levels.","type":"string","example":"company","enum":["open","company","collaborators"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.effective_access","typeLabel":"enum\u003cstring>"},"effective_permission":{"description":"The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder.","type":"string","example":"can_download","enum":["can_edit","can_download","can_preview","no_access"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.effective_permission","typeLabel":"enum\u003cstring>"},"is_password_enabled":{"description":"Defines if the shared link requires a password to access the item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.is_password_enabled","typeLabel":"boolean"},"download_count":{"description":"The number of times this item has been downloaded.","type":"integer","example":3,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.download_count","typeLabel":"integer"},"preview_count":{"description":"The number of times this item has been previewed.","type":"integer","example":3,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.preview_count","typeLabel":"integer"},"one_time_passcode":{"type":"object","title":"Shared link OTP settings","description":"The one-time-passcode (OTP) settings for this shared link.\n\nThis field is always present. For links where OTP does not apply (for example, shared links whose `access` is not `open`), the object is returned with `mode` set to `none`.","required":["mode"],"properties":{"mode":{"description":"The current OTP enforcement mode for the shared link.\n\n- `none` - OTP enforcement is turned off. The shared link is accessible without any one-time-passcode verification.\n- `open` - Any anonymous recipient can request a one-time-passcode to any email address and access the shared link after verifying it. Collaborators and registered Box users access the link without being prompted.\n- `allowlist` - Anonymous recipients can request a one-time-passcode only when they enter an email that matches an entry on the `allowlist`.","type":"string","example":"allowlist","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.mode","typeLabel":"string"},"allowlist":{"description":"The list of email and domain entries that are permitted to access the shared link when `mode` is `allowlist`. Anonymous users whose email matches an entry can request and verify a one-time-passcode.\n\nBecause the entries carry recipient email addresses and the identity of the user who added them, this field is only returned to users with owner, co-owner, or editor access on the item. For viewer collaborators and below the field is omitted.\n\nAn allowlist contains at most 1000 entries, matching the limit enforced when setting the allowlist on a shared link.","type":"array","items":{"description":"An entry on the OTP allowlist for a shared link. The entry can match either a specific email address or every email address that belongs to a domain.","type":"object","properties":{"type":{"description":"The kind of allowlist entry.\n\n- `email` - The entry matches a single email address.\n- `domain` - The entry matches every email address under the given domain.","type":"string","example":"email","enum":["email","domain"],"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"The value of the allowlist entry.\n\n- For `email` entries, the full email address (must contain `@`).\n- For `domain` entries, the bare domain (e.g. `example.com`).","type":"string","example":"alice@example.com","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].value","typeLabel":"string"},"created_at":{"description":"The date and time when the allowlist entry was added.","type":"string","format":"date-time","example":"2026-05-19T12:00:00Z","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"object","title":"User (Base)","description":"User who added this entry.","required":["type","id"],"x-box-resource-id":"user--base","x-box-tag":"users","x-box-variant":"base","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by","typeLabel":"User (Base) · object"}},"required":["type","value","created_at","created_by"],"title":"Shared link OTP allowlist entry","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX]","typeLabel":"Shared link OTP allowlist entry · object"},"example":[{"type":"email","value":"alice@example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}},{"type":"domain","value":"example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}}],"maxItems":1000,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode.allowlist","typeLabel":"Shared link OTP allowlist entry · object[]"}},"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.one_time_passcode","typeLabel":"Shared link OTP settings · object"},"download_url":{"oneOf":[{"description":"A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.","type":"string","format":"url","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","x-box-premium-feature":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.download_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.","type":"null","format":"url","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","x-box-premium-feature":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.download_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.download_url","typeLabel":"string\u003curl> | null"},"vanity_url":{"oneOf":[{"description":"The \"Custom URL\" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.","type":"string","format":"url","example":"https://acme.app.box.com/v/my_url/","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.vanity_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"The \"Custom URL\" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.","type":"null","format":"url","example":"https://acme.app.box.com/v/my_url/","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.vanity_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.vanity_url","typeLabel":"string\u003curl> | null"},"vanity_name":{"oneOf":[{"description":"The custom name of a shared link, as used in the `vanity_url` field.","type":"string","example":"my_url","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.vanity_name.oneOf.0","typeLabel":"string"},{"description":"The custom name of a shared link, as used in the `vanity_url` field.","type":"null","example":"my_url","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.vanity_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.vanity_name","typeLabel":"string | null"},"access":{"description":"The access level for this shared link.\n\n- `open` - provides access to this item to anyone with this link\n- `company` - only provides access to this item to people the same company\n- `collaborators` - only provides access to this item to people who are collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin.","type":"string","example":"open","enum":["open","company","collaborators"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.access","typeLabel":"enum\u003cstring>"},"unshared_at":{"oneOf":[{"description":"The date and time when this link will be unshared. This field can only be set by users with paid accounts.","type":"string","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.unshared_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time when this link will be unshared. This field can only be set by users with paid accounts.","type":"null","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.unshared_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.unshared_at","typeLabel":"string\u003cdate-time> | null"},"permissions":{"description":"Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself.","type":"object","properties":{"can_download":{"description":"Defines if the shared link allows for the item to be downloaded. For shared links on folders, this also applies to any items in the folder.\n\nThis value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.permissions.can_download","typeLabel":"boolean"},"can_preview":{"description":"Defines if the shared link allows for the item to be previewed.\n\nThis value is always `true`. For shared links on folders this also applies to any items in the folder.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.permissions.can_preview","typeLabel":"boolean"},"can_edit":{"description":"Defines if the shared link allows for the item to be edited.\n\nThis value can only be `true` if `can_download` is also `true` and if the item has a type of `file`.","type":"boolean","example":false,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.permissions.can_edit","typeLabel":"boolean"}},"required":["can_download","can_preview","can_edit"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0.permissions","typeLabel":"object"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.0","typeLabel":"Shared link · object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.shared_link","typeLabel":"Shared link · object | null"},"folder_upload_email":{"oneOf":[{"description":"The `folder_upload_email` parameter is not `null` if one of the following options is **true**:\n\n- The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.\n\n- The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).\n\nIf the conditions are not met, the parameter will have the following value: `folder_upload_email: null`.","type":"object","properties":{"access":{"description":"When this parameter has been set, users can email files to the email address that has been automatically created for this folder.\n\nTo create an email address, set this property either when creating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email addresses for collaborators will be accepted. This includes any email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email address.","type":"string","example":"open","enum":["open","collaborators"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.folder_upload_email.oneOf.0.access","typeLabel":"enum\u003cstring>"},"email":{"description":"The optional upload email address for this folder.","type":"string","format":"email","example":"upload.Contracts.asd7asd@u.box.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.folder_upload_email.oneOf.0.email","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.folder_upload_email.oneOf.0","typeLabel":"object"},{"description":"The `folder_upload_email` parameter is not `null` if one of the following options is **true**:\n\n- The **Allow uploads to this folder via email** and the **Only allow email uploads from collaborators in this folder** are [enabled for a folder in the Admin Console](https://support.box.com/hc/en-us/articles/360043697534-Upload-to-Box-Through-Email), and the user has at least **Upload** permissions granted.\n\n- The **Allow uploads to this folder via email** setting is enabled for a folder in the Admin Console, and the **Only allow email uploads from collaborators in this folder** setting is deactivated (unchecked).\n\nIf the conditions are not met, the parameter will have the following value: `folder_upload_email: null`.","type":"null","properties":{"access":{"description":"When this parameter has been set, users can email files to the email address that has been automatically created for this folder.\n\nTo create an email address, set this property either when creating or updating the folder.\n\nWhen set to `collaborators`, only emails from registered email addresses for collaborators will be accepted. This includes any email aliases a user might have registered.\n\nWhen set to `open` it will accept emails from any email address.","type":"string","example":"open","enum":["open","collaborators"],"nullable":false},"email":{"description":"The optional upload email address for this folder.","type":"string","format":"email","example":"upload.Contracts.asd7asd@u.box.com","nullable":false}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.folder_upload_email.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.folder_upload_email","typeLabel":"object | null"},"parent":{"oneOf":[{"type":"object","title":"Folder (Mini)","description":"The optional folder that this folder is located within.\n\nThis value may be `null` for some folders such as the root folder or the trash folder.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0.name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.0","typeLabel":"Folder (Mini) · object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.parent","typeLabel":"Folder (Mini) · object | null"},"item_status":{"description":"Defines if this item has been deleted or not.\n\n- `active` when the item has is not in the trash\n- `trashed` when the item has been moved to the trash but not deleted\n- `deleted` when the item has been permanently deleted.","type":"string","example":"active","enum":["active","trashed","deleted"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_status","typeLabel":"enum\u003cstring>"},"item_collection":{"type":"object","title":"Items","description":"A page of the items that are in the folder.\n\nThis field can only be requested when querying a folder's information, not when querying a folder's items.","x-box-resource-id":"items","x-box-tag":"folders","properties":{"limit":{"type":"integer","description":"The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.","format":"int64","example":1000,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.limit","typeLabel":"integer\u003cint64>"},"next_marker":{"oneOf":[{"description":"The marker for the start of the next page of results.","type":"string","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.next_marker.oneOf.0","typeLabel":"string"},{"description":"The marker for the start of the next page of results.","type":"null","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.next_marker.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.next_marker","typeLabel":"string | null"},"prev_marker":{"oneOf":[{"description":"The marker for the start of the previous page of results.","type":"string","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.prev_marker.oneOf.0","typeLabel":"string"},{"description":"The marker for the start of the previous page of results.","type":"null","example":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.prev_marker.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.prev_marker","typeLabel":"string | null"},"total_count":{"description":"One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than `total_count`.\n\nThis field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.","type":"integer","format":"int64","example":5000,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.total_count","typeLabel":"integer\u003cint64>"},"offset":{"description":"The 0-based offset of the first entry in this set. This will be the same as the `offset` query parameter.\n\nThis field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.","type":"integer","format":"int64","example":2000,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.offset","typeLabel":"integer\u003cint64>"},"order":{"description":"The order by which items are returned.\n\nThis field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.","type":"array","items":{"type":"object","description":"The order in which a pagination is ordered.","properties":{"by":{"description":"The field to order by.","type":"string","example":"type","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.order.items.[INDEX].by","typeLabel":"string"},"direction":{"description":"The direction to order by, either ascending or descending.","type":"string","example":"ASC","enum":["ASC","DESC"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.order.items.[INDEX].direction","typeLabel":"enum\u003cstring>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.order.items.[INDEX]","typeLabel":"object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.order","typeLabel":"object[]"},"entries":{"description":"The items in this collection.","type":"array","items":{"oneOf":[{"type":"object","title":"File (Full)","description":"A full representation of a file, as can be returned from any file API endpoints by default.","required":["id","type"],"x-box-resource-id":"file--full","x-box-tag":"files","x-box-variant":"full","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a file.\n\nThe ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.id","typeLabel":"string"},"type":{"description":"The value will always be `file`.","type":"string","example":"file","enum":["file"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this file. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the file if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.etag","typeLabel":"string | null"},"sequence_id":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.sequence_id","typeLabel":"any"},"name":{"description":"The name of the file.","type":"string","example":"Contract.pdf","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.name","typeLabel":"string"},"sha1":{"description":"The SHA1 hash of the file. This can be used to compare the contents of a file on Box with a local file.","type":"string","format":"digest","example":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.sha1","typeLabel":"string\u003cdigest>"},"file_version":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.file_version","typeLabel":"any"},"description":{"description":"The optional description of this file. If the description exceeds 255 characters, the first 255 characters are set as a file description and the rest of it is ignored.","type":"string","example":"Contract for Q1 renewal","maxLength":255,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.description","typeLabel":"string"},"size":{"description":"The file size in bytes. Be careful parsing this integer as it can get very large and cause an integer overflow.","type":"integer","example":629644,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.size","typeLabel":"integer"},"path_collection":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.path_collection","typeLabel":"any"},"created_at":{"description":"The date and time when the file was created on Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"description":"The date and time when the file was last updated on Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.modified_at","typeLabel":"string\u003cdate-time>"},"trashed_at":{"oneOf":[{"description":"The time at which this file was put in the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.trashed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The time at which this file was put in the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.trashed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.trashed_at","typeLabel":"string\u003cdate-time> | null"},"purged_at":{"oneOf":[{"description":"The time at which this file is expected to be purged from the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.purged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The time at which this file is expected to be purged from the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.purged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.purged_at","typeLabel":"string\u003cdate-time> | null"},"content_created_at":{"oneOf":[{"description":"The date and time at which this file was originally created, which might be before it was uploaded to Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.content_created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time at which this file was originally created, which might be before it was uploaded to Box.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.content_created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.content_created_at","typeLabel":"string\u003cdate-time> | null"},"content_modified_at":{"oneOf":[{"description":"The date and time at which this file was last updated, which might be before it was uploaded to Box.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.content_modified_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time at which this file was last updated, which might be before it was uploaded to Box.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.content_modified_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.content_modified_at","typeLabel":"string\u003cdate-time> | null"},"created_by":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.created_by","typeLabel":"any"},"modified_by":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.modified_by","typeLabel":"any"},"owned_by":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.owned_by","typeLabel":"any"},"shared_link":{"oneOf":[{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link","typeLabel":"any | null"},"parent":{"oneOf":[{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.parent.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.parent.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.parent","typeLabel":"any | null"},"item_status":{"description":"Defines if this item has been deleted or not.\n\n- `active` when the item has is not in the trash\n- `trashed` when the item has been moved to the trash but not deleted\n- `deleted` when the item has been permanently deleted.","type":"string","example":"active","enum":["active","trashed","deleted"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.item_status","typeLabel":"enum\u003cstring>"},"version_number":{"description":"The version number of this file.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.version_number","typeLabel":"string"},"comment_count":{"description":"The number of comments on this file.","type":"integer","example":10,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.comment_count","typeLabel":"integer"},"permissions":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.permissions","typeLabel":"any"},"tags":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.tags","typeLabel":"any"},"lock":{"oneOf":[{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.lock.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.lock.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.lock","typeLabel":"any | null"},"extension":{"description":"Indicates the (optional) file extension for this file. By default, this is set to an empty string.","type":"string","example":"pdf","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.extension","typeLabel":"string"},"is_package":{"description":"Indicates if the file is a package. Packages are commonly used by Mac Applications and can include iWork files.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.is_package","typeLabel":"boolean"},"expiring_embed_link":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.expiring_embed_link","typeLabel":"any"},"watermark_info":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.watermark_info","typeLabel":"any"},"is_accessible_via_shared_link":{"description":"Specifies if the file can be accessed via the direct shared link or a shared link to a parent folder.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.is_accessible_via_shared_link","typeLabel":"boolean"},"allowed_invitee_roles":{"description":"A list of the types of roles that user can be invited at when sharing this file.","type":"array","items":{"type":"string","enum":["editor","viewer","previewer","uploader","previewer uploader","viewer uploader","co-owner"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.allowed_invitee_roles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["editor"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.allowed_invitee_roles","typeLabel":"enum\u003cstring>[]"},"is_externally_owned":{"description":"Specifies if this file is owned by a user outside of the authenticated enterprise.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.is_externally_owned","typeLabel":"boolean"},"has_collaborations":{"description":"Specifies if this file has any other collaborators.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.has_collaborations","typeLabel":"boolean"},"metadata":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.metadata","typeLabel":"any"},"expires_at":{"oneOf":[{"description":"When the file will automatically be deleted.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When the file will automatically be deleted.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"representations":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.representations","typeLabel":"any"},"classification":{"oneOf":[{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.classification.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.classification.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.classification","typeLabel":"any | null"},"uploader_display_name":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.uploader_display_name","typeLabel":"any"},"disposition_at":{"oneOf":[{"description":"The retention expiration timestamp for the given file.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.disposition_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The retention expiration timestamp for the given file.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.disposition_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.disposition_at","typeLabel":"string\u003cdate-time> | null"},"shared_link_permission_options":{"oneOf":[{"description":"A list of the types of roles that user can be invited at when sharing this file.","type":"array","items":{"type":"string","enum":["can_preview","can_download","can_edit"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link_permission_options.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["can_preview"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link_permission_options.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"description":"A list of the types of roles that user can be invited at when sharing this file.","type":"null","items":{"type":"string","enum":["can_preview","can_download","can_edit"]},"example":["can_preview"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link_permission_options.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.shared_link_permission_options","typeLabel":"enum\u003cstring>[] | null"},"is_associated_with_app_item":{"description":"This field will return true if the file or any ancestor of the file is associated with at least one app item. Note that this will return true even if the context user does not have access to the app item(s) associated with the file.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.is_associated_with_app_item","typeLabel":"boolean"},"collections":{"description":"The collections that this file belongs to.\n\nFor more information, see the [collections guide](/guides/collections).","type":"array","items":{"description":"A collection of items, including files and folders.\n\nCurrently, the only collection available is the `favorites` collection.\n\nThe contents of a collection can be explored in a similar way to which the contents of a folder is explored.","type":"object","properties":{"id":{"description":"The unique identifier for this collection.","type":"string","example":"11446498","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.collections.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `collection`.","type":"string","example":"collection","enum":["collection"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.collections.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"description":"The name of the collection.","type":"string","example":"Favorites","enum":["Favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.collections.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"collection_type":{"description":"The type of the collection. This is used to determine the proper visual treatment for collections.","type":"string","example":"favorites","enum":["favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.collections.items.[INDEX].collection_type","typeLabel":"enum\u003cstring>"}},"title":"Collection","x-box-resource-id":"collection","x-box-tag":"collections","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.collections.items.[INDEX]","typeLabel":"Collection · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.collections","typeLabel":"Collection · object[]"},"is_download_available":{"description":"Whether the file's binary content is eligible to be downloaded.\n\nThis is a content-level flag and does not reflect whether the current user is authorized to download the file. Use `permissions.can_download`, when available, for that.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.is_download_available","typeLabel":"boolean"},"download_url":{"description":"A pre-authorized, expiring URL for directly downloading the file's content. Requires authentication and is valid only for the current session.\n\nThis field is only returned for files, not folders or web links.","type":"string","format":"url","example":"https://dl.boxcloud.com/d/1/example_token/download","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.download_url","typeLabel":"string\u003curl>"},"authenticated_download_url":{"description":"A stable API URL for the file content endpoint, `/2.0/files/{id}/content`. Unlike `download_url`, authorization is evaluated when the URL is requested with a valid access token.\n\nThis field is only returned for files, not folders or web links.","type":"string","format":"url","example":"https://api.box.com/2.0/files/12345/content","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.authenticated_download_url","typeLabel":"string\u003curl>"},"allowed_shared_link_access_levels":{"description":"The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this file.\n\nThe list depends on item policy and user authorization, so it may be narrower than the levels available to the owner. An empty array means no access level is available to this user.","type":"array","items":{"title":"Shared link access level","type":"string","description":"The access level for a shared link.","example":"open","enum":["open","company","collaborators"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.allowed_shared_link_access_levels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["open"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0.allowed_shared_link_access_levels","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.0","typeLabel":"File (Full) · object"},{"type":"object","title":"Folder (Mini)","description":"A mini representation of a file version, used when nested under another resource.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.etag","typeLabel":"string | null"},"sequence_id":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.sequence_id","typeLabel":"any"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1.name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.1","typeLabel":"Folder (Mini) · object"},{"type":"object","title":"Web link","description":"Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application.\n\nWeb link objects are treated similarly to file objects, they will also support most actions that apply to regular files.","required":["id","type"],"x-box-resource-id":"web_link","x-box-tag":"web_links","x-box-variant":"standard","x-box-variants":["base","mini","standard"],"properties":{"id":{"description":"The unique identifier for this web link.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.id","typeLabel":"string"},"type":{"description":"The value will always be `web_link`.","type":"string","example":"web_link","enum":["web_link"],"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"etag":{"description":"The entity tag of this web link. Used with `If-Match` headers.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.etag","typeLabel":"string"},"url":{"description":"The URL this web link points to.","type":"string","example":"https://www.example.com/example/1234","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.url","typeLabel":"string"},"sequence_id":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.sequence_id","typeLabel":"any"},"name":{"description":"The name of the web link.","type":"string","example":"My Bookmark","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.name","typeLabel":"string"},"parent":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.parent","typeLabel":"any"},"description":{"description":"The description accompanying the web link. This is visible within the Box web application.","type":"string","example":"Example page","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.description","typeLabel":"string"},"path_collection":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.path_collection","typeLabel":"any"},"created_at":{"description":"When this file was created on Box’s servers.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"description":"When this file was last updated on the Box servers.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.modified_at","typeLabel":"string\u003cdate-time>"},"trashed_at":{"oneOf":[{"description":"When this file was moved to the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.trashed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When this file was moved to the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.trashed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.trashed_at","typeLabel":"string\u003cdate-time> | null"},"purged_at":{"oneOf":[{"description":"When this file will be permanently deleted.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.purged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When this file will be permanently deleted.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.purged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.purged_at","typeLabel":"string\u003cdate-time> | null"},"created_by":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.created_by","typeLabel":"any"},"modified_by":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.modified_by","typeLabel":"any"},"owned_by":{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.owned_by","typeLabel":"any"},"shared_link":{"oneOf":[{"type":"any","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.shared_link.oneOf.0","typeLabel":"any"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.shared_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.shared_link","typeLabel":"any | null"},"item_status":{"description":"Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted.","type":"string","example":"active","enum":["active","trashed","deleted"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.item_status","typeLabel":"enum\u003cstring>"},"collections":{"description":"The collections that this web link belongs to.\n\nFor more information, see the [collections guide](/guides/collections).","type":"array","items":{"description":"A collection of items, including files and folders.\n\nCurrently, the only collection available is the `favorites` collection.\n\nThe contents of a collection can be explored in a similar way to which the contents of a folder is explored.","type":"object","properties":{"id":{"description":"The unique identifier for this collection.","type":"string","example":"11446498","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.collections.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `collection`.","type":"string","example":"collection","enum":["collection"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.collections.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"description":"The name of the collection.","type":"string","example":"Favorites","enum":["Favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.collections.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"collection_type":{"description":"The type of the collection. This is used to determine the proper visual treatment for collections.","type":"string","example":"favorites","enum":["favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.collections.items.[INDEX].collection_type","typeLabel":"enum\u003cstring>"}},"title":"Collection","x-box-resource-id":"collection","x-box-tag":"collections","uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.collections.items.[INDEX]","typeLabel":"Collection · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.collections","typeLabel":"Collection · object[]"},"allowed_shared_link_access_levels":{"description":"The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this web link.\n\nThe list depends on item policy and user authorization, so it may be narrower than the levels available to the owner. An empty array means no access level is available to this user.","type":"array","items":{"title":"Shared link access level","type":"string","description":"The access level for a shared link.","example":"open","enum":["open","company","collaborators"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.allowed_shared_link_access_levels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["open"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2.allowed_shared_link_access_levels","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX].oneOf.2","typeLabel":"Web link · object"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries.items.[INDEX]","typeLabel":"File (Full) · object | Folder (Mini) · object | Web link · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection.entries","typeLabel":"(File (Full) · object | Folder (Mini) · object | Web link · object)[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.item_collection","typeLabel":"Items · object"},"sync_state":{"type":"string","description":"Specifies whether a folder should be synced to a user's device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.","enum":["synced","not_synced","partially_synced"],"example":"synced","uniqueKey":"entries.items.[INDEX].item.oneOf.1.sync_state","typeLabel":"enum\u003cstring>"},"has_collaborations":{"description":"Specifies if this folder has any other collaborators.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.has_collaborations","typeLabel":"boolean"},"permissions":{"type":"object","description":"Describes the permissions that the current user has for this folder.","required":["can_upload","can_delete","can_download","can_invite_collaborator","can_rename","can_set_share_access","can_share"],"properties":{"can_delete":{"description":"Specifies if the current user can delete this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_delete","typeLabel":"boolean"},"can_download":{"description":"Specifies if the current user can download this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_download","typeLabel":"boolean"},"can_invite_collaborator":{"description":"Specifies if the current user can invite new users to collaborate on this item, and if the user can update the role of a user already collaborated on this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_invite_collaborator","typeLabel":"boolean"},"can_rename":{"description":"Specifies if the user can rename this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_rename","typeLabel":"boolean"},"can_set_share_access":{"description":"Specifies if the user can change the access level of an existing shared link on this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_set_share_access","typeLabel":"boolean"},"can_share":{"description":"Specifies if the user can create a shared link for this item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_share","typeLabel":"boolean"},"can_upload":{"description":"Specifies if the user can upload into this folder.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_upload","typeLabel":"boolean"},"can_apply_watermark":{"description":"Specifies if the user can apply a watermark to this folder and its contents.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions.can_apply_watermark","typeLabel":"boolean"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.permissions","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"entries.items.[INDEX].item.oneOf.1.tags.items.[INDEX]","typeLabel":"string"},"description":"The tags for this item. These tags are shown in the Box web app and mobile apps next to an item.\n\nTo add or remove a tag, retrieve the item's current tags, modify them, and then update this field.\n\nThere is a limit of 100 tags per item, and 10,000 unique tags per enterprise.","maxItems":100,"minItems":1,"example":["approved"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.tags","typeLabel":"string[]"},"can_non_owners_invite":{"type":"boolean","description":"Specifies if users who are not the owner of the folder can invite new collaborators to the folder.","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.can_non_owners_invite","typeLabel":"boolean"},"is_externally_owned":{"description":"Specifies if this folder is owned by a user outside of the authenticated enterprise.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.is_externally_owned","typeLabel":"boolean"},"metadata":{"type":"object","title":"Item metadata instances","description":"An object containing the metadata instances that have been attached to this folder.\n\nEach metadata instance is uniquely identified by its `scope` and `templateKey`. There can only be one instance of any metadata template attached to each folder. Each metadata instance is nested within an object with the `templateKey` as the key, which again itself is nested in an object with the `scope` as the key.","example":{"enterprise_27335":{"marketingCollateral":{"$canEdit":true,"$id":"01234500-12f1-1234-aa12-b1d234cb567e","$parent":"folder_59449484661","$scope":"enterprise_27335","$template":"marketingCollateral","$type":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","$typeVersion":2,"$version":1}}},"additionalProperties":{"type":"object","description":"A list of metadata instances, nested within key-value pairs of their `scope` and `templateKey`.","example":{"marketingCollateral":{"$canEdit":true,"$id":"01234500-12f1-1234-aa12-b1d234cb567e","$parent":"folder_59449484661","$scope":"enterprise_27335","$template":"marketingCollateral","$type":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","$typeVersion":2,"$version":1}},"additionalProperties":{"type":"object","title":"Metadata instance (Full)","description":"An instance of a metadata template, which has been applied to a file or folder.","x-box-resource-id":"metadata--full","x-box-tag":"file_metadata","x-box-variant":"full","x-box-variants":["base","standard","full"],"properties":{"$parent":{"description":"The identifier of the item that this metadata instance has been attached to. This combines the `type` and the `id` of the parent in the form `{type}_{id}`.","type":"string","example":"folder_59449484661,","uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$parent","typeLabel":"string"},"$template":{"description":"The name of the template.","type":"string","example":"marketingCollateral","uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$template","typeLabel":"string"},"$scope":{"description":"An ID for the scope in which this template has been applied. This will be `enterprise_{enterprise_id}` for templates defined for use in this enterprise, and `global` for general templates that are available to all enterprises using Box.","type":"string","example":"enterprise_27335","uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$scope","typeLabel":"string"},"$version":{"description":"The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.","type":"integer","example":1,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$version","typeLabel":"integer"},"$canEdit":{"description":"Whether the user can edit this metadata instance.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$canEdit","typeLabel":"boolean"},"$id":{"description":"A UUID to identify the metadata instance.","type":"string","format":"uuid","example":"01234500-12f1-1234-aa12-b1d234cb567e","maxLength":36,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$id","typeLabel":"string\u003cuuid>"},"$type":{"description":"A unique identifier for the \"type\" of this instance. This is an internal system property and should not be used by a client application.","type":"string","example":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$type","typeLabel":"string"},"$typeVersion":{"description":"The last-known version of the template of the object. This is an internal system property and should not be used by a client application.","type":"integer","example":2,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.$typeVersion","typeLabel":"integer"}},"additionalProperties":{"description":"A value for each of the fields that are present on the metadata template. For the `global.properties` template this can be a list of zero or more fields, as this template allows for any generic key-value pairs to be stored stored in the template.","x-box-example-key":"name","example":"Aaron Levie","uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties.additionalProperties","typeLabel":"any"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties.additionalProperties","typeLabel":"Metadata instance (Full) · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata.additionalProperties","typeLabel":"object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.metadata","typeLabel":"Item metadata instances · object"},"is_collaboration_restricted_to_enterprise":{"type":"boolean","description":"Specifies if new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations.","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.is_collaboration_restricted_to_enterprise","typeLabel":"boolean"},"allowed_shared_link_access_levels":{"description":"The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this folder.\n\nThe list depends on item policy and user authorization. For some folders, like the root folder, this is always empty as sharing is not allowed at that level.","type":"array","items":{"title":"Shared link access level","type":"string","description":"The access level for a shared link.","example":"open","enum":["open","company","collaborators"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.allowed_shared_link_access_levels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["open"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.allowed_shared_link_access_levels","typeLabel":"enum\u003cstring>[]"},"allowed_invitee_roles":{"description":"A list of the types of roles that user can be invited at when sharing this folder.","type":"array","items":{"type":"string","enum":["editor","viewer","previewer","uploader","previewer uploader","viewer uploader","co-owner"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.allowed_invitee_roles.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["editor"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.allowed_invitee_roles","typeLabel":"enum\u003cstring>[]"},"watermark_info":{"type":"object","description":"Details about the watermark applied to this folder.","properties":{"is_watermarked":{"description":"Specifies if this item has a watermark applied.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.watermark_info.is_watermarked","typeLabel":"boolean"},"is_watermark_inherited":{"description":"Specifies if the watermark is inherited from any parent folder in the hierarchy.","type":"boolean","example":false,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.watermark_info.is_watermark_inherited","typeLabel":"boolean"},"is_watermarked_by_access_policy":{"description":"Specifies if the watermark is enforced by an access policy.","type":"boolean","example":false,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.watermark_info.is_watermarked_by_access_policy","typeLabel":"boolean"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.watermark_info","typeLabel":"object"},"is_accessible_via_shared_link":{"description":"Specifies if the folder can be accessed with the direct shared link or a shared link to a parent folder.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.is_accessible_via_shared_link","typeLabel":"boolean"},"can_non_owners_view_collaborators":{"description":"Specifies if collaborators who are not owners of this folder are restricted from viewing other collaborations on this folder.\n\nIt also restricts non-owners from inviting new collaborators.","type":"boolean","example":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.can_non_owners_view_collaborators","typeLabel":"boolean"},"classification":{"type":"object","description":"Details about the classification applied to this folder.","properties":{"name":{"description":"The name of the classification.","type":"string","example":"Top Secret","uniqueKey":"entries.items.[INDEX].item.oneOf.1.classification.name","typeLabel":"string"},"definition":{"description":"An explanation of the meaning of this classification.","type":"string","example":"Content that should not be shared outside the company.","uniqueKey":"entries.items.[INDEX].item.oneOf.1.classification.definition","typeLabel":"string"},"color":{"description":"The color that is used to display the classification label in a user-interface. Colors are defined by the admin or co-admin who created the classification in the Box web app.","type":"string","example":"#FF0000","uniqueKey":"entries.items.[INDEX].item.oneOf.1.classification.color","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.classification","typeLabel":"object"},"is_associated_with_app_item":{"description":"This field will return true if the folder or any ancestor of the folder is associated with at least one app item. Note that this will return true even if the context user does not have access to the app item(s) associated with the folder.","type":"boolean","example":true,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.1.is_associated_with_app_item","typeLabel":"boolean"},"collections":{"description":"The collections that this folder belongs to.\n\nFor more information, see the [collections guide](/guides/collections).","type":"array","items":{"description":"A collection of items, including files and folders.\n\nCurrently, the only collection available is the `favorites` collection.\n\nThe contents of a collection can be explored in a similar way to which the contents of a folder is explored.","type":"object","properties":{"id":{"description":"The unique identifier for this collection.","type":"string","example":"11446498","uniqueKey":"entries.items.[INDEX].item.oneOf.1.collections.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `collection`.","type":"string","example":"collection","enum":["collection"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.collections.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"description":"The name of the collection.","type":"string","example":"Favorites","enum":["Favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.collections.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"collection_type":{"description":"The type of the collection. This is used to determine the proper visual treatment for collections.","type":"string","example":"favorites","enum":["favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.1.collections.items.[INDEX].collection_type","typeLabel":"enum\u003cstring>"}},"title":"Collection","x-box-resource-id":"collection","x-box-tag":"collections","uniqueKey":"entries.items.[INDEX].item.oneOf.1.collections.items.[INDEX]","typeLabel":"Collection · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.1.collections","typeLabel":"Collection · object[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.1","typeLabel":"Folder (Full) · object"},{"type":"object","title":"Web link","description":"The item that was recently accessed.","required":["id","type"],"x-box-resource-id":"web_link","x-box-tag":"web_links","x-box-variant":"standard","x-box-variants":["base","mini","standard"],"properties":{"id":{"description":"The unique identifier for this web link.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.id","typeLabel":"string"},"type":{"description":"The value will always be `web_link`.","type":"string","example":"web_link","enum":["web_link"],"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.type","typeLabel":"enum\u003cstring>"},"etag":{"description":"The entity tag of this web link. Used with `If-Match` headers.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.2.etag","typeLabel":"string"},"url":{"description":"The URL this web link points to.","type":"string","example":"https://www.example.com/example/1234","uniqueKey":"entries.items.[INDEX].item.oneOf.2.url","typeLabel":"string"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.2.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.2.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the web link.","type":"string","example":"My Bookmark","uniqueKey":"entries.items.[INDEX].item.oneOf.2.name","typeLabel":"string"},"parent":{"type":"object","title":"Folder (Mini)","description":"The parent object the web link belongs to.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent.name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.parent","typeLabel":"Folder (Mini) · object"},"description":{"description":"The description accompanying the web link. This is visible within the Box web application.","type":"string","example":"Example page","uniqueKey":"entries.items.[INDEX].item.oneOf.2.description","typeLabel":"string"},"path_collection":{"type":"object","title":"Path collection","description":"The tree of folders that this web link is contained in, starting at the root.","required":["total_count","entries"],"properties":{"total_count":{"description":"The number of folders in this list.","type":"integer","format":"int64","example":1,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.total_count","typeLabel":"integer\u003cint64>"},"entries":{"description":"The parent folders for this item.","type":"array","items":{"type":"object","title":"Folder (Mini)","description":"A mini representation of a file version, used when nested under another resource.","required":["id","type"],"x-box-resource-id":"folder--mini","x-box-tag":"folders","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier that represent a folder.\n\nThe ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.","type":"string","example":"12345","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `folder`.","type":"string","example":"folder","enum":["folder"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"etag":{"oneOf":[{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"string","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].etag.oneOf.0","typeLabel":"string"},{"description":"The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.","type":"null","example":"1","uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].etag.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].etag","typeLabel":"string | null"},"sequence_id":{"oneOf":[{"type":"string","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].sequence_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"A numeric identifier that represents the most recent user event that has been applied to this item.\n\nThis can be used in combination with the `GET /events`-endpoint to filter out user events that would have occurred before this identifier was read.\n\nAn example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the `sequence_id` in the event is smaller than or equal to the `sequence_id` in the originally fetched resource.","example":"3","uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].sequence_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].sequence_id","typeLabel":"string | null"},"name":{"description":"The name of the folder.","type":"string","example":"Contracts","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries.items.[INDEX]","typeLabel":"Folder (Mini) · object"},"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection.entries","typeLabel":"Folder (Mini) · object[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.path_collection","typeLabel":"Path collection · object"},"created_at":{"description":"When this file was created on Box’s servers.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.created_at","typeLabel":"string\u003cdate-time>"},"modified_at":{"description":"When this file was last updated on the Box servers.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.modified_at","typeLabel":"string\u003cdate-time>"},"trashed_at":{"oneOf":[{"description":"When this file was moved to the trash.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.trashed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When this file was moved to the trash.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.trashed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.trashed_at","typeLabel":"string\u003cdate-time> | null"},"purged_at":{"oneOf":[{"description":"When this file will be permanently deleted.","type":"string","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.purged_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"When this file will be permanently deleted.","type":"null","format":"date-time","example":"2012-12-12T10:53:43-08:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.purged_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.purged_at","typeLabel":"string\u003cdate-time> | null"},"created_by":{"type":"object","title":"User (Mini)","description":"The user who created this web link.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.created_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.created_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.created_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.created_by","typeLabel":"User (Mini) · object"},"modified_by":{"type":"object","title":"User (Mini)","description":"The user who last modified this web link.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.modified_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.modified_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.modified_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.modified_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.modified_by","typeLabel":"User (Mini) · object"},"owned_by":{"type":"object","title":"User (Mini)","description":"The user who owns this web link.","required":["type","id"],"x-box-resource-id":"user--mini","x-box-tag":"users","x-box-variant":"mini","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.owned_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.owned_by.type","typeLabel":"enum\u003cstring>"},"name":{"description":"The display name of this user.","type":"string","example":"Aaron Levie","maxLength":50,"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.owned_by.name","typeLabel":"string"},"login":{"description":"The primary email address of this user.","type":"string","format":"email","example":"ceo@example.com","nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.owned_by.login","typeLabel":"string\u003cemail>"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.owned_by","typeLabel":"User (Mini) · object"},"shared_link":{"oneOf":[{"type":"object","title":"Shared link","description":"The shared link object for this item. Will be `null` if no shared link has been created.","required":["url","accessed","effective_access","effective_permission","is_password_enabled","download_count","preview_count","one_time_passcode"],"properties":{"url":{"description":"The URL that can be used to access the item on Box.\n\nThis URL will display the item in Box's preview UI where the file can be downloaded if allowed.\n\nThis URL will continue to work even when a custom `vanity_url` has been set for this shared link.","type":"string","format":"url","example":"https://www.box.com/s/vspke7y05sb214wjokpk","nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.url","typeLabel":"string\u003curl>"},"effective_access":{"description":"The effective access level for the shared link. This can be a more restrictive access level than the value in the `access` field when the enterprise settings restrict the allowed access levels.","type":"string","example":"company","enum":["open","company","collaborators"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.effective_access","typeLabel":"enum\u003cstring>"},"effective_permission":{"description":"The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder.","type":"string","example":"can_download","enum":["can_edit","can_download","can_preview","no_access"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.effective_permission","typeLabel":"enum\u003cstring>"},"is_password_enabled":{"description":"Defines if the shared link requires a password to access the item.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.is_password_enabled","typeLabel":"boolean"},"download_count":{"description":"The number of times this item has been downloaded.","type":"integer","example":3,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.download_count","typeLabel":"integer"},"preview_count":{"description":"The number of times this item has been previewed.","type":"integer","example":3,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.preview_count","typeLabel":"integer"},"one_time_passcode":{"type":"object","title":"Shared link OTP settings","description":"The one-time-passcode (OTP) settings for this shared link.\n\nThis field is always present. For links where OTP does not apply (for example, shared links whose `access` is not `open`), the object is returned with `mode` set to `none`.","required":["mode"],"properties":{"mode":{"description":"The current OTP enforcement mode for the shared link.\n\n- `none` - OTP enforcement is turned off. The shared link is accessible without any one-time-passcode verification.\n- `open` - Any anonymous recipient can request a one-time-passcode to any email address and access the shared link after verifying it. Collaborators and registered Box users access the link without being prompted.\n- `allowlist` - Anonymous recipients can request a one-time-passcode only when they enter an email that matches an entry on the `allowlist`.","type":"string","example":"allowlist","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.mode","typeLabel":"string"},"allowlist":{"description":"The list of email and domain entries that are permitted to access the shared link when `mode` is `allowlist`. Anonymous users whose email matches an entry can request and verify a one-time-passcode.\n\nBecause the entries carry recipient email addresses and the identity of the user who added them, this field is only returned to users with owner, co-owner, or editor access on the item. For viewer collaborators and below the field is omitted.\n\nAn allowlist contains at most 1000 entries, matching the limit enforced when setting the allowlist on a shared link.","type":"array","items":{"description":"An entry on the OTP allowlist for a shared link. The entry can match either a specific email address or every email address that belongs to a domain.","type":"object","properties":{"type":{"description":"The kind of allowlist entry.\n\n- `email` - The entry matches a single email address.\n- `domain` - The entry matches every email address under the given domain.","type":"string","example":"email","enum":["email","domain"],"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"value":{"description":"The value of the allowlist entry.\n\n- For `email` entries, the full email address (must contain `@`).\n- For `domain` entries, the bare domain (e.g. `example.com`).","type":"string","example":"alice@example.com","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].value","typeLabel":"string"},"created_at":{"description":"The date and time when the allowlist entry was added.","type":"string","format":"date-time","example":"2026-05-19T12:00:00Z","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"created_by":{"type":"object","title":"User (Base)","description":"User who added this entry.","required":["type","id"],"x-box-resource-id":"user--base","x-box-tag":"users","x-box-variant":"base","x-box-variants":["base","mini","standard","full"],"properties":{"id":{"description":"The unique identifier for this user.","type":"string","example":"11446498","isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by.id","typeLabel":"string"},"type":{"description":"The value will always be `user`.","type":"string","example":"user","enum":["user"],"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX].created_by","typeLabel":"User (Base) · object"}},"required":["type","value","created_at","created_by"],"title":"Shared link OTP allowlist entry","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist.items.[INDEX]","typeLabel":"Shared link OTP allowlist entry · object"},"example":[{"type":"email","value":"alice@example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}},{"type":"domain","value":"example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}}],"maxItems":1000,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode.allowlist","typeLabel":"Shared link OTP allowlist entry · object[]"}},"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.one_time_passcode","typeLabel":"Shared link OTP settings · object"},"download_url":{"oneOf":[{"description":"A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.","type":"string","format":"url","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","x-box-premium-feature":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.download_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.\n\nThis property will be `null` for folders.","type":"null","format":"url","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","x-box-premium-feature":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.download_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.download_url","typeLabel":"string\u003curl> | null"},"vanity_url":{"oneOf":[{"description":"The \"Custom URL\" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.","type":"string","format":"url","example":"https://acme.app.box.com/v/my_url/","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.vanity_url.oneOf.0","typeLabel":"string\u003curl>"},{"description":"The \"Custom URL\" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.","type":"null","format":"url","example":"https://acme.app.box.com/v/my_url/","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.vanity_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.vanity_url","typeLabel":"string\u003curl> | null"},"vanity_name":{"oneOf":[{"description":"The custom name of a shared link, as used in the `vanity_url` field.","type":"string","example":"my_url","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.vanity_name.oneOf.0","typeLabel":"string"},{"description":"The custom name of a shared link, as used in the `vanity_url` field.","type":"null","example":"my_url","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.vanity_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.vanity_name","typeLabel":"string | null"},"access":{"description":"The access level for this shared link.\n\n- `open` - provides access to this item to anyone with this link\n- `company` - only provides access to this item to people the same company\n- `collaborators` - only provides access to this item to people who are collaborators on this item\n\nIf this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin.","type":"string","example":"open","enum":["open","company","collaborators"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.access","typeLabel":"enum\u003cstring>"},"unshared_at":{"oneOf":[{"description":"The date and time when this link will be unshared. This field can only be set by users with paid accounts.","type":"string","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.unshared_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"description":"The date and time when this link will be unshared. This field can only be set by users with paid accounts.","type":"null","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.unshared_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.unshared_at","typeLabel":"string\u003cdate-time> | null"},"permissions":{"description":"Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself.","type":"object","properties":{"can_download":{"description":"Defines if the shared link allows for the item to be downloaded. For shared links on folders, this also applies to any items in the folder.\n\nThis value can be set to `true` when the effective access level is set to `open` or `company`, not `collaborators`.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.permissions.can_download","typeLabel":"boolean"},"can_preview":{"description":"Defines if the shared link allows for the item to be previewed.\n\nThis value is always `true`. For shared links on folders this also applies to any items in the folder.","type":"boolean","example":true,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.permissions.can_preview","typeLabel":"boolean"},"can_edit":{"description":"Defines if the shared link allows for the item to be edited.\n\nThis value can only be `true` if `can_download` is also `true` and if the item has a type of `file`.","type":"boolean","example":false,"nullable":false,"isRequired":true,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.permissions.can_edit","typeLabel":"boolean"}},"required":["can_download","can_preview","can_edit"],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0.permissions","typeLabel":"object"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.0","typeLabel":"Shared link · object"},{"type":"null","uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link.oneOf.1","typeLabel":"null"}],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.shared_link","typeLabel":"Shared link · object | null"},"item_status":{"description":"Whether this item is deleted or not. Values include `active`, `trashed` if the file has been moved to the trash, and `deleted` if the file has been permanently deleted.","type":"string","example":"active","enum":["active","trashed","deleted"],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.item_status","typeLabel":"enum\u003cstring>"},"collections":{"description":"The collections that this web link belongs to.\n\nFor more information, see the [collections guide](/guides/collections).","type":"array","items":{"description":"A collection of items, including files and folders.\n\nCurrently, the only collection available is the `favorites` collection.\n\nThe contents of a collection can be explored in a similar way to which the contents of a folder is explored.","type":"object","properties":{"id":{"description":"The unique identifier for this collection.","type":"string","example":"11446498","uniqueKey":"entries.items.[INDEX].item.oneOf.2.collections.items.[INDEX].id","typeLabel":"string"},"type":{"description":"The value will always be `collection`.","type":"string","example":"collection","enum":["collection"],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.collections.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"description":"The name of the collection.","type":"string","example":"Favorites","enum":["Favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.collections.items.[INDEX].name","typeLabel":"enum\u003cstring>"},"collection_type":{"description":"The type of the collection. This is used to determine the proper visual treatment for collections.","type":"string","example":"favorites","enum":["favorites"],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.collections.items.[INDEX].collection_type","typeLabel":"enum\u003cstring>"}},"title":"Collection","x-box-resource-id":"collection","x-box-tag":"collections","uniqueKey":"entries.items.[INDEX].item.oneOf.2.collections.items.[INDEX]","typeLabel":"Collection · object"},"uniqueKey":"entries.items.[INDEX].item.oneOf.2.collections","typeLabel":"Collection · object[]"},"allowed_shared_link_access_levels":{"description":"The shared link access levels the authenticated user is allowed to use when creating or updating a shared link for this web link.\n\nThe list depends on item policy and user authorization, so it may be narrower than the levels available to the owner. An empty array means no access level is available to this user.","type":"array","items":{"title":"Shared link access level","type":"string","description":"The access level for a shared link.","example":"open","enum":["open","company","collaborators"],"uniqueKey":"entries.items.[INDEX].item.oneOf.2.allowed_shared_link_access_levels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["open"],"nullable":false,"uniqueKey":"entries.items.[INDEX].item.oneOf.2.allowed_shared_link_access_levels","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"entries.items.[INDEX].item.oneOf.2","typeLabel":"Web link · object"}],"uniqueKey":"entries.items.[INDEX].item","typeLabel":"File (Full) · object | Folder (Full) · object | Web link · object"},"interaction_type":{"description":"The most recent type of access the user performed on the item.","type":"string","example":"item_preview","enum":["item_preview","item_upload","item_comment","item_open","item_modify"],"uniqueKey":"entries.items.[INDEX].interaction_type","typeLabel":"enum\u003cstring>"},"interacted_at":{"description":"The time of the most recent interaction.","type":"string","format":"date-time","example":"2018-04-13T13:53:23-07:00","uniqueKey":"entries.items.[INDEX].interacted_at","typeLabel":"string\u003cdate-time>"},"interaction_shared_link":{"description":"If the item was accessed through a shared link it will appear here, otherwise this will be null.","type":"string","example":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","uniqueKey":"entries.items.[INDEX].interaction_shared_link","typeLabel":"string"}},"title":"Recent item","x-box-resource-id":"recent_item","x-box-tag":"recent_items","uniqueKey":"entries.items.[INDEX]","typeLabel":"Recent item · object"},"uniqueKey":"entries","typeLabel":"Recent item · object[]"}},"uniqueKey":"","typeLabel":"Recent items · object"},"examples":{"Example":{"title":"Example","value":{"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","prev_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih","entries":[{"type":"recent_item","item":{"id":"12345","type":"file","etag":"1","sequence_id":"3","name":"Contract.pdf","sha1":"85136C79CBF9FE36BB9D05D0639C70C265C18D37","file_version":{"id":"12345","type":"file_version","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"},"description":"Contract for Q1 renewal","size":629644,"path_collection":{"total_count":1,"entries":[{"id":"12345","type":"folder","etag":"1","sequence_id":"3","name":"Contracts"}]},"created_at":"2012-12-12T10:53:43-08:00","modified_at":"2012-12-12T10:53:43-08:00","trashed_at":"2012-12-12T10:53:43-08:00","purged_at":"2012-12-12T10:53:43-08:00","content_created_at":"2012-12-12T10:53:43-08:00","content_modified_at":"2012-12-12T10:53:43-08:00","created_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"modified_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"owned_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"shared_link":{"url":"https://www.box.com/s/vspke7y05sb214wjokpk","effective_access":"company","effective_permission":"can_download","is_password_enabled":true,"download_count":3,"preview_count":3,"one_time_passcode":{"mode":"allowlist","allowlist":[{"type":"email","value":"alice@example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}},{"type":"domain","value":"example.com","created_at":"2026-05-19T12:00:00Z","created_by":{"id":"11446498","type":"user"}}]},"download_url":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","vanity_url":"https://acme.app.box.com/v/my_url/","vanity_name":"my_url","access":"open","unshared_at":"2018-04-13T13:53:23-07:00","permissions":{"can_download":true,"can_preview":true,"can_edit":false}},"parent":{"id":"12345","type":"folder","etag":"1","sequence_id":"3","name":"Contracts"},"item_status":"active","version_number":"1","comment_count":10,"permissions":{"can_delete":true,"can_download":true,"can_invite_collaborator":true,"can_rename":true,"can_set_share_access":true,"can_share":true,"can_annotate":true,"can_comment":true,"can_preview":true,"can_upload":true,"can_view_annotations_all":true,"can_view_annotations_self":true,"can_apply_watermark":true},"tags":["approved"],"lock":{"id":"11446498","type":"lock","created_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"created_at":"2012-12-12T10:53:43-08:00","expired_at":"2012-12-12T10:53:43-08:00","is_download_prevented":true,"app_type":"office_wopiplus"},"extension":"pdf","is_package":true,"expiring_embed_link":{"access_token":"c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ","expires_in":3600,"token_type":"bearer","restricted_to":[{"scope":"item_download","object":{"id":"12345","type":"folder","etag":"1","sequence_id":"3","name":"Contracts"}}],"url":"https://cloud.app.box.com/preview/expiring_embed/..."},"watermark_info":{"is_watermarked":true,"is_watermark_inherited":false,"is_watermarked_by_access_policy":false},"is_accessible_via_shared_link":true,"allowed_invitee_roles":["editor"],"is_externally_owned":true,"has_collaborations":true,"metadata":{"enterprise_27335":{"marketingCollateral":{"$canEdit":true,"$id":"01234500-12f1-1234-aa12-b1d234cb567e","$parent":"folder_59449484661","$scope":"enterprise_27335","$template":"marketingCollateral","$type":"properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0","$typeVersion":2,"$version":1}}},"expires_at":"2012-12-12T10:53:43-08:00","representations":{"entries":[{"content":{"url_template":"https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"},"info":{"url":"https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"},"properties":{"dimensions":"2048x2048","paged":"true","thumb":"true"},"representation":"png","status":{"state":"success"}}]},"classification":{"name":"Top Secret","definition":"Content that should not be shared outside the company.","color":"#FF0000"},"uploader_display_name":"Ellis Wiggins","disposition_at":"2012-12-12T10:53:43-08:00","shared_link_permission_options":["can_preview"],"is_associated_with_app_item":true,"collections":[{"id":"11446498","type":"collection","name":"Favorites","collection_type":"favorites"}],"is_download_available":true,"download_url":"https://dl.boxcloud.com/d/1/example_token/download","authenticated_download_url":"https://api.box.com/2.0/files/12345/content","allowed_shared_link_access_levels":["open"]},"interaction_type":"item_preview","interacted_at":"2018-04-13T13:53:23-07:00","interaction_shared_link":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"cc698e0b-8829-4923-bec9-a0f011a7bdc0":{"description":"An unexpected client error.","content":{"application/json":{"schema":{"description":"A generic error.","type":"object","properties":{"type":{"description":"The value will always be `error`.","type":"string","example":"error","enum":["error"],"nullable":false,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"status":{"description":"The HTTP status of the response.","type":"integer","format":"int32","example":400,"nullable":false,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"code":{"description":"A Box-specific error code.","type":"string","example":"item_name_invalid","enum":["created","accepted","no_content","redirect","not_modified","bad_request","unauthorized","forbidden","not_found","method_not_allowed","conflict","precondition_failed","unprocessable_entity","too_many_requests","internal_server_error","unavailable","item_name_invalid","insufficient_scope"],"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"description":"A short message describing the error.","type":"string","example":"Method Not Allowed","nullable":false,"uniqueKey":"message","typeLabel":"string"},"context_info":{"oneOf":[{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"object","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.0.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.0","typeLabel":"object"},{"description":"A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.","type":"null","example":{"message":"Something went wrong"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"context_info.oneOf.1.additionalProperties","typeLabel":"any"},"uniqueKey":"context_info.oneOf.1","typeLabel":"null"}],"uniqueKey":"context_info","typeLabel":"object | null"},"help_url":{"description":"A URL that links to more information about why this error occurred.","type":"string","example":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","nullable":false,"uniqueKey":"help_url","typeLabel":"string"},"request_id":{"description":"A unique identifier for this response, which can be used when contacting Box support.","type":"string","example":"abcdef123456","nullable":false,"uniqueKey":"request_id","typeLabel":"string"}},"title":"Client error","x-box-resource-id":"client_error","uniqueKey":"","typeLabel":"Client error · object"},"examples":{"Example":{"title":"Example","value":{"type":"error","status":400,"code":"item_name_invalid","message":"Method Not Allowed","context_info":{"message":"Something went wrong"},"help_url":"https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/","request_id":"abcdef123456"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"df597f82-bd13-4225-8987-b23444140d5e":{"OAuth2Security":{"type":"oauth2","description":"The access token received from the authorization server in the OAuth 2.0 flow.","flows":{"authorizationCode":{"authorizationUrl":"https://account.box.com/api/oauth2/authorize","tokenUrl":"https://api.box.com/oauth2/token","scopes":{"root_readonly":"Read all files and folders stored in Box","root_readwrite":"Read and write all files and folders stored in Box","manage_app_users":"Provision and manage app users","manage_managed_users":"Provision and manage managed users","manage_groups":"Manage an enterprise's groups","manage_webhook":"Create webhooks programmatically through the API","manage_enterprise_properties":"Manage enterprise properties","manage_data_retention":"Manage data retention polices","manage_legal_hold":"Manage Legal Holds"}}},"scopes":[],"schemeName":"OAuth2Security"}}},"servers":{"8683cf83-a9de-408a-ab12-b8e2f203be5d":{"url":"https://api.box.com/2.0","description":"Box Platform API server."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"The access token received from the authorization server in the OAuth 2.0 flow.","flows":{"authorizationCode":{"authorizationUrl":"https://account.box.com/api/oauth2/authorize","tokenUrl":"https://api.box.com/oauth2/token","scopes":{"root_readonly":"Read all files and folders stored in Box","root_readwrite":"Read and write all files and folders stored in Box","manage_app_users":"Provision and manage app users","manage_managed_users":"Provision and manage managed users","manage_groups":"Manage an enterprise's groups","manage_webhook":"Create webhooks programmatically through the API","manage_enterprise_properties":"Manage enterprise properties","manage_data_retention":"Manage data retention polices","manage_legal_hold":"Manage Legal Holds"}}},"scopes":[],"schemeName":"OAuth2Security"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2Security","name":"Authorization"}],"title":"OAuth2Security"}]},"originalFileLocation":"box-openapi.json"},"subdomain":"box","siteName":"Box Dev Docs","title":"List recently accessed items - Box Dev Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/reference/get-recent-items","matchLevel":0},"ja":{"href":"/ja/reference/get-recent-items","matchLevel":1}}},"lastModified":"2026-03-25T11:57:59.776Z","gitLastModified":"2026-01-23T14:40:02.000Z","originalFileLocation":"reference/get-recent-items.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.\">\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=\"List recently accessed items - Box Dev Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.\">\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/get-recent-items\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://box.mintlify.app/_mintlify/api/og/v2?division=Recent+items\u0026amp;title=List+recently+accessed+items\u0026amp;description=Returns+information+about+the+recent+items+accessed+by+a+user%2C+either+in+the+last+90+days+or+up+to+the+last+1000+items+accessed.\u0026amp;theme=7c006b8b877970d319badcf9\u0026amp;signature=ed6bdb12591b6be26dc003cd1de493b519960cef5e8a694a637d555598228f7f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List recently accessed items - Box Dev Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://box.mintlify.app/_mintlify/api/og/v2?division=Recent+items\u0026amp;title=List+recently+accessed+items\u0026amp;description=Returns+information+about+the+recent+items+accessed+by+a+user%2C+either+in+the+last+90+days+or+up+to+the+last+1000+items+accessed.\u0026amp;theme=7c006b8b877970d319badcf9\u0026amp;signature=ed6bdb12591b6be26dc003cd1de493b519960cef5e8a694a637d555598228f7f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\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/get-recent-items\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/get-recent-items.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://developer.box.com/reference/get-recent-items\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://developer.box.com/ja/reference/get-recent-items\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://developer.box.com/reference/get-recent-items\">\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/get-recent-items#webpage\",\"url\":\"https://developer.box.com/reference/get-recent-items\",\"name\":\"List recently accessed 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.\",\"dateModified\":\"2026-01-23T14:40:02.000Z\",\"isPartOf\":{\"@id\":\"https://developer.box.com#website\"},\"breadcrumb\":{\"@id\":\"https://developer.box.com/reference/get-recent-items#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.box.com/reference/get-recent-items#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://developer.box.com/reference/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Recent items\",\"item\":\"https://developer.box.com/reference/recent-items-resources\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List recently accessed items\",\"item\":\"https://developer.box.com/reference/get-recent-items\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.box.com/reference/get-recent-items#apireference\",\"headline\":\"List recently accessed items\",\"name\":\"List recently accessed 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.\",\"url\":\"https://developer.box.com/reference/get-recent-items\",\"mainEntityOfPage\":{\"@id\":\"https://developer.box.com/reference/get-recent-items#webpage\"},\"dateModified\":\"2026-01-23T14:40:02.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","href":"/reference"},{"group":"AI","root":{"title":"AI resources","href":"/reference/ai-resources"},"pages":[{"title":"Get AI agent default configuration","openapi":"box-openapi.json GET /ai_agent_default","href":"/reference/get-ai-agent-default"},{"title":"Ask question","openapi":"box-openapi.json POST /ai/ask","href":"/reference/post-ai-ask"},{"title":"Extract metadata (freeform)","openapi":"box-openapi.json POST /ai/extract","href":"/reference/post-ai-extract"},{"title":"Extract metadata (structured)","openapi":"box-openapi.json POST /ai/extract_structured","href":"/reference/post-ai-extract-structured"},{"title":"Generate text","openapi":"box-openapi.json POST /ai/text_gen","href":"/reference/post-ai-text-gen"}]},{"group":"AI Studio","root":{"title":"AI Studio resources","href":"/reference/ai-studio-resources"},"pages":[{"title":"Get AI agent by agent ID","openapi":"box-openapi.json GET /ai_agents/{agent_id}","href":"/reference/get-ai-agents-id"},{"title":"List AI agents","openapi":"box-openapi.json GET /ai_agents","href":"/reference/get-ai-agents"},{"title":"Create AI agent","openapi":"box-openapi.json POST /ai_agents","href":"/reference/post-ai-agents"},{"title":"Update AI agent","openapi":"box-openapi.json PUT /ai_agents/{agent_id}","href":"/reference/put-ai-agents-id"},{"title":"Delete AI agent","openapi":"box-openapi.json DELETE /ai_agents/{agent_id}","href":"/reference/delete-ai-agents-id"}]},{"group":"App item associations","root":{"title":"App item associations resources","href":"/reference/app-item-associations-resources"},"pages":[{"title":"List file app item associations","openapi":"box-openapi.json GET /files/{file_id}/app_item_associations","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","href":"/reference/get-folders-id-app-item-associations"}]},{"group":"Authorization","root":{"title":"Authorization resources","href":"/reference/authorization-resources"},"pages":[{"title":"Authorize user","openapi":"box-openapi.json GET /authorize","href":"/reference/get-authorize"},{"title":"Refresh access token","openapi":"box-openapi.json POST /oauth2/token#refresh","href":"/reference/post-oauth2-token--refresh"},{"title":"Request access token","openapi":"box-openapi.json POST /oauth2/token","href":"/reference/post-oauth2-token"},{"title":"Revoke access token","openapi":"box-openapi.json POST /oauth2/revoke","href":"/reference/post-oauth2-revoke"}]},{"group":"Box Sign requests","root":{"title":"Box Sign requests resources","href":"/reference/sign-requests-resources"},"pages":[{"title":"Get Box Sign request by ID","openapi":"box-openapi.json GET /sign_requests/{sign_request_id}","href":"/reference/get-sign-requests-id"},{"title":"List Box Sign requests","openapi":"box-openapi.json GET /sign_requests","href":"/reference/get-sign-requests"},{"title":"Cancel Box Sign request","openapi":"box-openapi.json POST /sign_requests/{sign_request_id}/cancel","href":"/reference/post-sign-requests-id-cancel"},{"title":"Create Box Sign request","openapi":"box-openapi.json POST /sign_requests","href":"/reference/post-sign-requests"},{"title":"Resend Box Sign request","openapi":"box-openapi.json POST /sign_requests/{sign_request_id}/resend","href":"/reference/post-sign-requests-id-resend"}]},{"group":"Box Sign templates","root":{"title":"Box Sign templates resources","href":"/reference/sign-templates-resources"},"pages":[{"title":"Get Box Sign template by ID","openapi":"box-openapi.json GET /sign_templates/{template_id}","href":"/reference/get-sign-templates-id"},{"title":"List Box Sign templates","openapi":"box-openapi.json GET /sign_templates","href":"/reference/get-sign-templates"}]},{"group":"Classifications","root":{"title":"Classifications resources","href":"/reference/classifications-resources"},"pages":[{"title":"List all classifications","openapi":"box-openapi.json GET /metadata_templates/enterprise/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","href":"/reference/post-metadata-templates-schema--classifications"},{"title":"Add classification","openapi":"box-openapi.json PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add","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","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","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","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","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","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","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","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","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","href":"/reference/delete-folders-id-metadata-enterprise-securityClassification-6VMVochwUWo"}]},{"group":"Collaborations","root":{"title":"Collaborations resources","href":"/reference/user-collaborations-resources"},"pages":[{"title":"Get collaboration","openapi":"box-openapi.json GET /collaborations/{collaboration_id}","href":"/reference/get-collaborations-id"},{"title":"Create collaboration","openapi":"box-openapi.json POST /collaborations","href":"/reference/post-collaborations"},{"title":"Update collaboration","openapi":"box-openapi.json PUT /collaborations/{collaboration_id}","href":"/reference/put-collaborations-id"},{"title":"Remove collaboration","openapi":"box-openapi.json DELETE /collaborations/{collaboration_id}","href":"/reference/delete-collaborations-id"}]},{"group":"Collaborations (List)","pages":[{"title":"List file collaborations","openapi":"box-openapi.json GET /files/{file_id}/collaborations","href":"/reference/get-files-id-collaborations"},{"title":"List folder collaborations","openapi":"box-openapi.json GET /folders/{folder_id}/collaborations","href":"/reference/get-folders-id-collaborations"},{"title":"List group collaborations","openapi":"box-openapi.json GET /groups/{group_id}/collaborations","href":"/reference/get-groups-id-collaborations"},{"title":"List pending collaborations","openapi":"box-openapi.json GET /collaborations","href":"/reference/get-collaborations"}]},{"group":"Collections","root":{"title":"Collections resources","href":"/reference/collections-resources"},"pages":[{"title":"Get collection by ID","openapi":"box-openapi.json GET /collections/{collection_id}","href":"/reference/get-collections-id"},{"title":"List all collections","openapi":"box-openapi.json GET /collections","href":"/reference/get-collections"},{"title":"List collection items","openapi":"box-openapi.json GET /collections/{collection_id}/items","href":"/reference/get-collections-id-items"}]},{"group":"Comments","root":{"title":"Comments resources","href":"/reference/comments-resources"},"pages":[{"title":"Get comment","openapi":"box-openapi.json GET /comments/{comment_id}","href":"/reference/get-comments-id"},{"title":"List file comments","openapi":"box-openapi.json GET /files/{file_id}/comments","href":"/reference/get-files-id-comments"},{"title":"Create comment","openapi":"box-openapi.json POST /comments","href":"/reference/post-comments"},{"title":"Update comment","openapi":"box-openapi.json PUT /comments/{comment_id}","href":"/reference/put-comments-id"},{"title":"Remove comment","openapi":"box-openapi.json DELETE /comments/{comment_id}","href":"/reference/delete-comments-id"}]},{"group":"Device pinners","root":{"title":"Device pinners resources","href":"/reference/device-pinners-resources"},"pages":[{"title":"Get device pin","openapi":"box-openapi.json GET /device_pinners/{device_pinner_id}","href":"/reference/get-device-pinners-id"},{"title":"List enterprise device pins","openapi":"box-openapi.json GET /enterprises/{enterprise_id}/device_pinners","href":"/reference/get-enterprises-id-device-pinners"},{"title":"Remove device pin","openapi":"box-openapi.json DELETE /device_pinners/{device_pinner_id}","href":"/reference/delete-device-pinners-id"}]},{"group":"Domain restrictions (User exemptions)","root":{"title":"Domain restrictions (User exemptions) resources","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}","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","href":"/reference/get-collaboration-whitelist-exempt-targets"},{"title":"Create user exemption from collaboration domain restrictions","openapi":"box-openapi.json POST /collaboration_whitelist_exempt_targets","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}","href":"/reference/delete-collaboration-whitelist-exempt-targets-id"}]},{"group":"Domain restrictions for collaborations","root":{"title":"Domain restrictions for collaborations resources","href":"/reference/collaboration-allowlist-entries-resources"},"pages":[{"title":"Get allowed collaboration domain","openapi":"box-openapi.json GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}","href":"/reference/get-collaboration-whitelist-entries-id"},{"title":"List allowed collaboration domains","openapi":"box-openapi.json GET /collaboration_whitelist_entries","href":"/reference/get-collaboration-whitelist-entries"},{"title":"Add domain to list of allowed collaboration domains","openapi":"box-openapi.json POST /collaboration_whitelist_entries","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}","href":"/reference/delete-collaboration-whitelist-entries-id"}]},{"group":"Downloads","pages":[{"title":"Download file","openapi":"box-openapi.json GET /files/{file_id}/content","href":"/reference/get-files-id-content"}]},{"group":"Email aliases","root":{"title":"Email aliases resources","href":"/reference/email-aliases-resources"},"pages":[{"title":"List user's email aliases","openapi":"box-openapi.json GET /users/{user_id}/email_aliases","href":"/reference/get-users-id-email-aliases"},{"title":"Create email alias","openapi":"box-openapi.json POST /users/{user_id}/email_aliases","href":"/reference/post-users-id-email-aliases"},{"title":"Remove email alias","openapi":"box-openapi.json DELETE /users/{user_id}/email_aliases/{email_alias_id}","href":"/reference/delete-users-id-email-aliases-id"}]},{"group":"Events","root":{"title":"Events resources","href":"/reference/events-resources"},"pages":[{"title":"List user and enterprise events","openapi":"box-openapi.json GET /events","href":"/reference/get-events"},{"title":"Get events long poll endpoint","openapi":"/box-openapi.json OPTIONS /events","href":"/reference/options-events"}]},{"group":"File requests","root":{"title":"File requests resources","href":"/reference/file-requests-resources"},"pages":[{"title":"Get file request","openapi":"box-openapi.json GET /file_requests/{file_request_id}","href":"/reference/get-file-requests-id"},{"title":"Copy file request","openapi":"box-openapi.json POST /file_requests/{file_request_id}/copy","href":"/reference/post-file-requests-id-copy"},{"title":"Update file request","openapi":"box-openapi.json PUT /file_requests/{file_request_id}","href":"/reference/put-file-requests-id"},{"title":"Delete file request","openapi":"box-openapi.json DELETE /file_requests/{file_request_id}","href":"/reference/delete-file-requests-id"}]},{"group":"File version legal holds","root":{"title":"File version legal holds resources","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}","href":"/reference/get-file-version-legal-holds-id"},{"title":"List file version legal holds","openapi":"box-openapi.json GET /file_version_legal_holds","href":"/reference/get-file-version-legal-holds"}]},{"group":"File version retentions","root":{"title":"File version retentions resources","href":"/reference/file-version-retentions-resources"},"pages":[{"title":"Get retention on file","openapi":"box-openapi.json GET /file_version_retentions/{file_version_retention_id}","href":"/reference/get-file-version-retentions-id"},{"title":"List file version retentions","openapi":"box-openapi.json GET /file_version_retentions","href":"/reference/get-file-version-retentions"}]},{"group":"File versions","root":{"title":"File versions resources","href":"/reference/file-versions-resources"},"pages":[{"title":"Get file version","openapi":"box-openapi.json GET /files/{file_id}/versions/{file_version_id}","href":"/reference/get-files-id-versions-id"},{"title":"List all file versions","openapi":"box-openapi.json GET /files/{file_id}/versions","href":"/reference/get-files-id-versions"},{"title":"Promote file version","openapi":"box-openapi.json POST /files/{file_id}/versions/current","href":"/reference/post-files-id-versions-current"},{"title":"Restore file version","openapi":"box-openapi.json PUT /files/{file_id}/versions/{file_version_id}","href":"/reference/put-files-id-versions-id"},{"title":"Remove file version","openapi":"box-openapi.json DELETE /files/{file_id}/versions/{file_version_id}","href":"/reference/delete-files-id-versions-id"}]},{"group":"Files","root":{"title":"Files resources","href":"/reference/files-resources"},"pages":[{"title":"Get file information","openapi":"box-openapi.json GET /files/{file_id}","href":"/reference/get-files-id"},{"title":"Get file thumbnail","openapi":"box-openapi.json GET /files/{file_id}/thumbnail.{extension}","href":"/reference/get-files-id-thumbnail-id"},{"title":"Copy file","openapi":"box-openapi.json POST /files/{file_id}/copy","href":"/reference/post-files-id-copy"},{"title":"Update file","openapi":"box-openapi.json PUT /files/{file_id}","href":"/reference/put-files-id"},{"title":"Delete file","openapi":"box-openapi.json DELETE /files/{file_id}","href":"/reference/delete-files-id"}]},{"group":"Folder Locks","root":{"title":"Folder Locks resources","href":"/reference/folder-locks-resources"},"pages":[{"title":"List folder locks","openapi":"box-openapi.json GET /folder_locks","href":"/reference/get-folder-locks"},{"title":"Create folder lock","openapi":"box-openapi.json POST /folder_locks","href":"/reference/post-folder-locks"},{"title":"Delete folder lock","openapi":"box-openapi.json DELETE /folder_locks/{folder_lock_id}","href":"/reference/delete-folder-locks-id"}]},{"group":"Folders","root":{"title":"Folders resources","href":"/reference/folders-resources"},"pages":[{"title":"Get folder information","openapi":"box-openapi.json GET /folders/{folder_id}","href":"/reference/get-folders-id"},{"title":"List items in folder","openapi":"box-openapi.json GET /folders/{folder_id}/items","href":"/reference/get-folders-id-items"},{"title":"Copy folder","openapi":"box-openapi.json POST /folders/{folder_id}/copy","href":"/reference/post-folders-id-copy"},{"title":"Create folder","openapi":"box-openapi.json POST /folders","href":"/reference/post-folders"},{"title":"Update folder","openapi":"box-openapi.json PUT /folders/{folder_id}","href":"/reference/put-folders-id"},{"title":"Delete folder","openapi":"box-openapi.json DELETE /folders/{folder_id}","href":"/reference/delete-folders-id"}]},{"group":"Group memberships","root":{"title":"Group memberships resources","href":"/reference/memberships-resources"},"pages":[{"title":"Get group membership","openapi":"box-openapi.json GET /group_memberships/{group_membership_id}","href":"/reference/get-group-memberships-id"},{"title":"List members of group","openapi":"box-openapi.json GET /groups/{group_id}/memberships","href":"/reference/get-groups-id-memberships"},{"title":"List user's groups","openapi":"box-openapi.json GET /users/{user_id}/memberships","href":"/reference/get-users-id-memberships"},{"title":"Add user to group","openapi":"box-openapi.json POST /group_memberships","href":"/reference/post-group-memberships"},{"title":"Update group membership","openapi":"box-openapi.json PUT /group_memberships/{group_membership_id}","href":"/reference/put-group-memberships-id"},{"title":"Remove user from group","openapi":"box-openapi.json DELETE /group_memberships/{group_membership_id}","href":"/reference/delete-group-memberships-id"}]},{"group":"Groups","root":{"title":"Groups resources","href":"/reference/groups-resources"},"pages":[{"title":"Get group","openapi":"box-openapi.json GET /groups/{group_id}","href":"/reference/get-groups-id"},{"title":"List groups for enterprise","openapi":"box-openapi.json GET /groups","href":"/reference/get-groups"},{"title":"Create group","openapi":"box-openapi.json POST /groups","href":"/reference/post-groups"},{"title":"Update group","openapi":"box-openapi.json PUT /groups/{group_id}","href":"/reference/put-groups-id"},{"title":"Remove group","openapi":"box-openapi.json DELETE /groups/{group_id}","href":"/reference/delete-groups-id"}]},{"group":"Integration mappings","root":{"title":"Integration mappings resources","href":"/reference/integration-mappings-resources"},"pages":[{"title":"List Slack integration mappings","openapi":"box-openapi.json GET /integration_mappings/slack","href":"/reference/get-integration-mappings-slack"},{"title":"List Teams integration mappings","openapi":"box-openapi.json GET /integration_mappings/teams","href":"/reference/get-integration-mappings-teams"},{"title":"Create Slack integration mapping","openapi":"box-openapi.json POST /integration_mappings/slack","href":"/reference/post-integration-mappings-slack"},{"title":"Create Teams integration mapping","openapi":"box-openapi.json POST /integration_mappings/teams","href":"/reference/post-integration-mappings-teams"},{"title":"Update Slack integration mapping","openapi":"box-openapi.json PUT /integration_mappings/slack/{integration_mapping_id}","href":"/reference/put-integration-mappings-slack-id"},{"title":"Update Teams integration mapping","openapi":"box-openapi.json PUT /integration_mappings/teams/{integration_mapping_id}","href":"/reference/put-integration-mappings-teams-id"},{"title":"Delete Slack integration mapping","openapi":"box-openapi.json DELETE /integration_mappings/slack/{integration_mapping_id}","href":"/reference/delete-integration-mappings-slack-id"},{"title":"Delete Teams integration mapping","openapi":"box-openapi.json DELETE /integration_mappings/teams/{integration_mapping_id}","href":"/reference/delete-integration-mappings-teams-id"}]},{"group":"Invites","root":{"title":"Invites resources","href":"/reference/invites-resources"},"pages":[{"title":"Get user invite status","openapi":"box-openapi.json GET /invites/{invite_id}","href":"/reference/get-invites-id"},{"title":"Create user invite","openapi":"box-openapi.json POST /invites","href":"/reference/post-invites"}]},{"group":"Legal hold policies","root":{"title":"Legal hold policies resources","href":"/reference/legal-hold-policies-resources"},"pages":[{"title":"Get legal hold policy","openapi":"box-openapi.json GET /legal_hold_policies/{legal_hold_policy_id}","href":"/reference/get-legal-hold-policies-id"},{"title":"List all legal hold policies","openapi":"box-openapi.json GET /legal_hold_policies","href":"/reference/get-legal-hold-policies"},{"title":"Create legal hold policy","openapi":"box-openapi.json POST /legal_hold_policies","href":"/reference/post-legal-hold-policies"},{"title":"Update legal hold policy","openapi":"box-openapi.json PUT /legal_hold_policies/{legal_hold_policy_id}","href":"/reference/put-legal-hold-policies-id"},{"title":"Remove legal hold policy","openapi":"box-openapi.json DELETE /legal_hold_policies/{legal_hold_policy_id}","href":"/reference/delete-legal-hold-policies-id"}]},{"group":"Legal hold policy assignments","root":{"title":"Legal hold policy assignments resources","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}","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","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","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","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","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}","href":"/reference/delete-legal-hold-policy-assignments-id"}]},{"group":"Metadata cascade policies","root":{"title":"Metadata cascade policies resources","href":"/reference/metadata-cascade-policies-resources"},"pages":[{"title":"Get metadata cascade policy","openapi":"box-openapi.json GET /metadata_cascade_policies/{metadata_cascade_policy_id}","href":"/reference/get-metadata-cascade-policies-id"},{"title":"List metadata cascade policies","openapi":"box-openapi.json GET /metadata_cascade_policies","href":"/reference/get-metadata-cascade-policies"},{"title":"Create metadata cascade policy","openapi":"box-openapi.json POST /metadata_cascade_policies","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","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}","href":"/reference/delete-metadata-cascade-policies-id"}]},{"group":"Metadata instances (Files)","root":{"title":"Metadata instances (Files) resources","href":"/reference/file-metadata-resources"},"pages":[{"title":"Get metadata instance on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/{scope}/{template_key}","href":"/reference/get-files-id-metadata-id-id"},{"title":"List metadata instances on file","openapi":"box-openapi.json GET /files/{file_id}/metadata","href":"/reference/get-files-id-metadata"},{"title":"Create metadata instance on file","openapi":"box-openapi.json POST /files/{file_id}/metadata/{scope}/{template_key}","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}","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}","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}","href":"/reference/get-folders-id-metadata-id-id"},{"title":"List metadata instances on folder","openapi":"box-openapi.json GET /folders/{folder_id}/metadata","href":"/reference/get-folders-id-metadata"},{"title":"Create metadata instance on folder","openapi":"box-openapi.json POST /folders/{folder_id}/metadata/{scope}/{template_key}","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}","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}","href":"/reference/delete-folders-id-metadata-id-id"}]},{"group":"Metadata taxonomies","root":{"title":"Metadata taxonomies resources","href":"/reference/metadata-taxonomies-resources"},"pages":[{"title":"Get metadata taxonomies for namespace","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}","href":"/reference/get-metadata-taxonomies-id"},{"title":"Get metadata taxonomy by taxonomy key","openapi":"box-openapi.json GET /metadata_taxonomies/{namespace}/{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}","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","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","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","href":"/reference/post-metadata-taxonomies-id-id-levels--append"},{"title":"Create metadata taxonomy","openapi":"box-openapi.json POST /metadata_taxonomies","href":"/reference/post-metadata-taxonomies"},{"title":"Create metadata taxonomy levels","openapi":"box-openapi.json POST /metadata_taxonomies/{namespace}/{taxonomy_key}/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","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","href":"/reference/post-metadata-taxonomies-id-id-levels--trim"},{"title":"Update metadata taxonomy","openapi":"box-openapi.json PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}","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}","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}","href":"/reference/patch-metadata-taxonomies-id-id-nodes-id"},{"title":"Remove metadata taxonomy","openapi":"box-openapi.json DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}","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}","href":"/reference/delete-metadata-taxonomies-id-id-nodes-id"}]},{"group":"Metadata templates","root":{"title":"Metadata templates resources","href":"/reference/metadata-templates-resources"},"pages":[{"title":"Find metadata template by instance ID","openapi":"box-openapi.json GET /metadata_templates","href":"/reference/get-metadata-templates"},{"title":"Get metadata template by ID","openapi":"box-openapi.json GET /metadata_templates/{template_id}","href":"/reference/get-metadata-templates-id"},{"title":"Get metadata template by name","openapi":"box-openapi.json GET /metadata_templates/{scope}/{template_key}/schema","href":"/reference/get-metadata-templates-id-id-schema"},{"title":"List all global metadata templates","openapi":"box-openapi.json GET /metadata_templates/global","href":"/reference/get-metadata-templates-global"},{"title":"List all metadata templates for enterprise","openapi":"box-openapi.json GET /metadata_templates/enterprise","href":"/reference/get-metadata-templates-enterprise"},{"title":"Create metadata template","openapi":"box-openapi.json POST /metadata_templates/schema","href":"/reference/post-metadata-templates-schema"},{"title":"Update metadata template","openapi":"box-openapi.json PUT /metadata_templates/{scope}/{template_key}/schema","href":"/reference/put-metadata-templates-id-id-schema"},{"title":"Remove metadata template","openapi":"box-openapi.json DELETE /metadata_templates/{scope}/{template_key}/schema","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","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}","href":"/reference/get-retention-policies-id"},{"title":"List retention policies","openapi":"box-openapi.json GET /retention_policies","href":"/reference/get-retention-policies"},{"title":"Create retention policy","openapi":"box-openapi.json POST /retention_policies","href":"/reference/post-retention-policies"},{"title":"Update retention policy","openapi":"box-openapi.json PUT /retention_policies/{retention_policy_id}","href":"/reference/put-retention-policies-id"},{"title":"Delete retention policy","openapi":"box-openapi.json DELETE /retention_policies/{retention_policy_id}","href":"/reference/delete-retention-policies-id"}]},{"group":"Retention policy assignments","root":{"title":"Retention policy assignments resources","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","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","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}","href":"/reference/get-retention-policy-assignments-id"},{"title":"List retention policy assignments","openapi":"box-openapi.json GET /retention_policies/{retention_policy_id}/assignments","href":"/reference/get-retention-policies-id-assignments"},{"title":"Assign retention policy","openapi":"box-openapi.json POST /retention_policy_assignments","href":"/reference/post-retention-policy-assignments"},{"title":"Remove retention policy assignment","openapi":"box-openapi.json DELETE /retention_policy_assignments/{retention_policy_assignment_id}","href":"/reference/delete-retention-policy-assignments-id"}]},{"group":"Search","root":{"title":"Search resources","href":"/reference/search-resources"},"pages":[{"title":"Search for content","openapi":"box-openapi.json GET /search","href":"/reference/get-search"},{"title":"Query files/folders by metadata","openapi":"box-openapi.json POST /metadata_queries/execute_read","href":"/reference/post-metadata-queries-execute-read"}]},{"group":"Session termination","root":{"title":"Session termination resources","href":"/reference/session-termination-resources"},"pages":[{"title":"Create jobs to terminate user group session","openapi":"box-openapi.json POST /groups/terminate_sessions","href":"/reference/post-groups-terminate-sessions"},{"title":"Create jobs to terminate users session","openapi":"box-openapi.json POST /users/terminate_sessions","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","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","href":"/reference/get-shared-items"},{"title":"Get shared link for file","openapi":"box-openapi.json GET /files/{file_id}#get_shared_link","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","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","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","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","href":"/reference/get-shared-items--folders"},{"title":"Get shared link for folder","openapi":"box-openapi.json GET /folders/{folder_id}#get_shared_link","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","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","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","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","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","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","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","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","href":"/reference/put-web-links-id--update-shared-link"}]},{"group":"Shield information barrier reports","root":{"title":"Shield information barrier reports resources","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}","href":"/reference/get-shield-information-barrier-reports-id"},{"title":"List shield information barrier reports","openapi":"box-openapi.json GET /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","href":"/reference/post-shield-information-barrier-reports"}]},{"group":"Shield information barrier segment members","root":{"title":"Shield information barrier segment members resources","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}","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","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","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}","href":"/reference/delete-shield-information-barrier-segment-members-id"}]},{"group":"Shield information barrier segment restrictions","root":{"title":"Shield information barrier segment restrictions resources","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}","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","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","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}","href":"/reference/delete-shield-information-barrier-segment-restrictions-id"}]},{"group":"Shield information barrier segments","root":{"title":"Shield information barrier segments resources","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}","href":"/reference/get-shield-information-barrier-segments-id"},{"title":"List shield information barrier segments","openapi":"box-openapi.json GET /shield_information_barrier_segments","href":"/reference/get-shield-information-barrier-segments"},{"title":"Create shield information barrier segment","openapi":"box-openapi.json POST /shield_information_barrier_segments","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}","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}","href":"/reference/delete-shield-information-barrier-segments-id"}]},{"group":"Shield information barriers","root":{"title":"Shield information barriers resources","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}","href":"/reference/get-shield-information-barriers-id"},{"title":"List shield information barriers","openapi":"box-openapi.json GET /shield_information_barriers","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","href":"/reference/post-shield-information-barriers-change-status"},{"title":"Create shield information barrier","openapi":"box-openapi.json POST /shield_information_barriers","href":"/reference/post-shield-information-barriers"}]},{"group":"Skills","root":{"title":"Skills resources","href":"/reference/skills-resources"},"pages":[{"title":"List Box Skill cards on file","openapi":"box-openapi.json GET /files/{file_id}/metadata/global/boxSkillsCards","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","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}","href":"/reference/put-skill-invocations-id"},{"title":"Update Box Skill cards on file","openapi":"box-openapi.json PUT /files/{file_id}/metadata/global/boxSkillsCards","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","href":"/reference/delete-files-id-metadata-global-boxSkillsCards"}]},{"group":"Standard and Zones Storage Policies","root":{"title":"Standard and Zones Storage Policies resources","href":"/reference/storage-policies-resources"},"pages":[{"title":"Get storage policy","openapi":"box-openapi.json GET /storage_policies/{storage_policy_id}","href":"/reference/get-storage-policies-id"},{"title":"List storage policies","openapi":"box-openapi.json GET /storage_policies","href":"/reference/get-storage-policies"}]},{"group":"Standard and Zones Storage Policy Assignments","root":{"title":"Standard and Zones Storage Policy Assignments resources","href":"/reference/storage-policy-assignments-resources"},"pages":[{"title":"Get storage policy assignment","openapi":"box-openapi.json GET /storage_policy_assignments/{storage_policy_assignment_id}","href":"/reference/get-storage-policy-assignments-id"},{"title":"List storage policy assignments","openapi":"box-openapi.json GET /storage_policy_assignments","href":"/reference/get-storage-policy-assignments"},{"title":"Assign storage policy","openapi":"box-openapi.json POST /storage_policy_assignments","href":"/reference/post-storage-policy-assignments"},{"title":"Update storage policy assignment","openapi":"box-openapi.json PUT /storage_policy_assignments/{storage_policy_assignment_id}","href":"/reference/put-storage-policy-assignments-id"},{"title":"Unassign storage policy","openapi":"box-openapi.json DELETE /storage_policy_assignments/{storage_policy_assignment_id}","href":"/reference/delete-storage-policy-assignments-id"}]},{"group":"Task assignments","root":{"title":"Task assignments resources","href":"/reference/task-assignments-resources"},"pages":[{"title":"Get task assignment","openapi":"box-openapi.json GET /task_assignments/{task_assignment_id}","href":"/reference/get-task-assignments-id"},{"title":"List task assignments","openapi":"box-openapi.json GET /tasks/{task_id}/assignments","href":"/reference/get-tasks-id-assignments"},{"title":"Assign task","openapi":"box-openapi.json POST /task_assignments","href":"/reference/post-task-assignments"},{"title":"Update task assignment","openapi":"box-openapi.json PUT /task_assignments/{task_assignment_id}","href":"/reference/put-task-assignments-id"},{"title":"Unassign task","openapi":"box-openapi.json DELETE /task_assignments/{task_assignment_id}","href":"/reference/delete-task-assignments-id"}]},{"group":"Tasks","root":{"title":"Tasks resources","href":"/reference/tasks-resources"},"pages":[{"title":"Get task","openapi":"box-openapi.json GET /tasks/{task_id}","href":"/reference/get-tasks-id"},{"title":"List tasks on file","openapi":"box-openapi.json GET /files/{file_id}/tasks","href":"/reference/get-files-id-tasks"},{"title":"Create task","openapi":"box-openapi.json POST /tasks","href":"/reference/post-tasks"},{"title":"Update task","openapi":"box-openapi.json PUT /tasks/{task_id}","href":"/reference/put-tasks-id"},{"title":"Remove task","openapi":"box-openapi.json DELETE /tasks/{task_id}","href":"/reference/delete-tasks-id"}]},{"group":"Terms of service","root":{"title":"Terms of service resources","href":"/reference/terms-of-services-resources"},"pages":[{"title":"Get terms of service","openapi":"box-openapi.json GET /terms_of_services/{terms_of_service_id}","href":"/reference/get-terms-of-services-id"},{"title":"List terms of services","openapi":"box-openapi.json GET /terms_of_services","href":"/reference/get-terms-of-services"},{"title":"Create terms of service","openapi":"box-openapi.json POST /terms_of_services","href":"/reference/post-terms-of-services"},{"title":"Update terms of service","openapi":"box-openapi.json PUT /terms_of_services/{terms_of_service_id}","href":"/reference/put-terms-of-services-id"}]},{"group":"Terms of service user statuses","root":{"title":"Terms of service user statuses resources","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","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","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}","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","href":"/reference/put-users-id-folders-0"}]},{"group":"Trashed files","root":{"title":"Trashed files resources","href":"/reference/trashed-files-resources"},"pages":[{"title":"Get trashed file","openapi":"box-openapi.json GET /files/{file_id}/trash","href":"/reference/get-files-id-trash"},{"title":"Restore file","openapi":"box-openapi.json POST /files/{file_id}","href":"/reference/post-files-id"},{"title":"Permanently remove file","openapi":"box-openapi.json DELETE /files/{file_id}/trash","href":"/reference/delete-files-id-trash"}]},{"group":"Trashed folders","root":{"title":"Trashed folders resources","href":"/reference/trashed-folders-resources"},"pages":[{"title":"Get trashed folder","openapi":"box-openapi.json GET /folders/{folder_id}/trash","href":"/reference/get-folders-id-trash"},{"title":"Restore folder","openapi":"box-openapi.json POST /folders/{folder_id}","href":"/reference/post-folders-id"},{"title":"Permanently remove folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/trash","href":"/reference/delete-folders-id-trash"}]},{"group":"Trashed items","pages":[{"title":"List trashed items","openapi":"box-openapi.json GET /folders/trash/items","href":"/reference/get-folders-trash-items"}]},{"group":"Trashed web links","root":{"title":"Trashed web links resources","href":"/reference/trashed-web-links-resources"},"pages":[{"title":"Get trashed web link","openapi":"box-openapi.json GET /web_links/{web_link_id}/trash","href":"/reference/get-web-links-id-trash"},{"title":"Restore web link","openapi":"box-openapi.json POST /web_links/{web_link_id}","href":"/reference/post-web-links-id"},{"title":"Permanently remove web link","openapi":"box-openapi.json DELETE /web_links/{web_link_id}/trash","href":"/reference/delete-web-links-id-trash"}]},{"group":"Uploads","root":{"title":"Uploads resources","href":"/reference/uploads-resources"},"pages":[{"title":"Upload file","openapi":"box-openapi.json POST /files/content","href":"/reference/post-files-content"},{"title":"Upload file version","openapi":"box-openapi.json POST /files/{file_id}/content","href":"/reference/post-files-id-content"},{"title":"Preflight check before upload","openapi":"/box-openapi.json OPTIONS /files/content","href":"/reference/options-files-content"}]},{"group":"Uploads (Chunked)","root":{"title":"Uploads (Chunked) resources","href":"/reference/chunked-uploads-resources"},"pages":[{"title":"Get upload session","openapi":"box-openapi.json GET /files/upload_sessions/{upload_session_id}","href":"/reference/get-files-upload-sessions-id"},{"title":"List parts","openapi":"box-openapi.json GET /files/upload_sessions/{upload_session_id}/parts","href":"/reference/get-files-upload-sessions-id-parts"},{"title":"Commit upload session","openapi":"box-openapi.json POST /files/upload_sessions/{upload_session_id}/commit","href":"/reference/post-files-upload-sessions-id-commit"},{"title":"Create upload session","openapi":"box-openapi.json POST /files/upload_sessions","href":"/reference/post-files-upload-sessions"},{"title":"Create upload session for existing file","openapi":"box-openapi.json POST /files/{file_id}/upload_sessions","href":"/reference/post-files-id-upload-sessions"},{"title":"Plan upload session","openapi":"box-openapi.json POST /files/upload_sessions/{upload_session_id}/plan","href":"/reference/post-files-upload-sessions-id-plan"},{"title":"Upload part of file","openapi":"box-openapi.json PUT /files/upload_sessions/{upload_session_id}","href":"/reference/put-files-upload-sessions-id"},{"title":"Remove upload session","openapi":"box-openapi.json DELETE /files/upload_sessions/{upload_session_id}","href":"/reference/delete-files-upload-sessions-id"}]},{"group":"User avatars","root":{"title":"User avatars resources","href":"/reference/avatars-resources"},"pages":[{"title":"Get user avatar","openapi":"box-openapi.json GET /users/{user_id}/avatar","href":"/reference/get-users-id-avatar"},{"title":"Add or update user avatar","openapi":"box-openapi.json POST /users/{user_id}/avatar","href":"/reference/post-users-id-avatar"},{"title":"Delete user avatar","openapi":"box-openapi.json DELETE /users/{user_id}/avatar","href":"/reference/delete-users-id-avatar"}]},{"group":"Users","root":{"title":"Users resources","href":"/reference/users-resources"},"pages":[{"title":"Get current user","openapi":"box-openapi.json GET /users/me","href":"/reference/get-users-me"},{"title":"Get user","openapi":"box-openapi.json GET /users/{user_id}","href":"/reference/get-users-id"},{"title":"List enterprise users","openapi":"box-openapi.json GET /users","href":"/reference/get-users"},{"title":"Create user","openapi":"box-openapi.json POST /users","href":"/reference/post-users"},{"title":"Update user","openapi":"box-openapi.json PUT /users/{user_id}","href":"/reference/put-users-id"},{"title":"Delete user","openapi":"box-openapi.json DELETE /users/{user_id}","href":"/reference/delete-users-id"}]},{"group":"Watermarks (Files)","root":{"title":"Watermarks (Files) resources","href":"/reference/file-watermarks-resources"},"pages":[{"title":"Get watermark on file","openapi":"box-openapi.json GET /files/{file_id}/watermark","href":"/reference/get-files-id-watermark"},{"title":"Apply watermark to file","openapi":"box-openapi.json PUT /files/{file_id}/watermark","href":"/reference/put-files-id-watermark"},{"title":"Remove watermark from file","openapi":"box-openapi.json DELETE /files/{file_id}/watermark","href":"/reference/delete-files-id-watermark"}]},{"group":"Watermarks (Folders)","pages":[{"title":"Get watermark for folder","openapi":"box-openapi.json GET /folders/{folder_id}/watermark","href":"/reference/get-folders-id-watermark"},{"title":"Apply watermark to folder","openapi":"box-openapi.json PUT /folders/{folder_id}/watermark","href":"/reference/put-folders-id-watermark"},{"title":"Remove watermark from folder","openapi":"box-openapi.json DELETE /folders/{folder_id}/watermark","href":"/reference/delete-folders-id-watermark"}]},{"group":"Web links","root":{"title":"Web links resources","href":"/reference/web-links-resources"},"pages":[{"title":"Get web link","openapi":"box-openapi.json GET /web_links/{web_link_id}","href":"/reference/get-web-links-id"},{"title":"Create web link","openapi":"box-openapi.json POST /web_links","href":"/reference/post-web-links"},{"title":"Update web link","openapi":"box-openapi.json PUT /web_links/{web_link_id}","href":"/reference/put-web-links-id"},{"title":"Remove web link","openapi":"box-openapi.json DELETE /web_links/{web_link_id}","href":"/reference/delete-web-links-id"}]},{"group":"Webhooks","root":{"title":"Webhooks resources","href":"/reference/webhooks-resources"},"pages":[{"title":"Get webhook","openapi":"box-openapi.json GET /webhooks/{webhook_id}","href":"/reference/get-webhooks-id"},{"title":"List all webhooks","openapi":"box-openapi.json GET /webhooks","href":"/reference/get-webhooks"},{"title":"Create webhook","openapi":"box-openapi.json POST /webhooks","href":"/reference/post-webhooks"},{"title":"Update webhook","openapi":"box-openapi.json PUT /webhooks/{webhook_id}","href":"/reference/put-webhooks-id"},{"title":"Remove webhook","openapi":"box-openapi.json DELETE /webhooks/{webhook_id}","href":"/reference/delete-webhooks-id"}]},{"group":"Workflows","root":{"title":"Workflows resources","href":"/reference/workflows-resources"},"pages":[{"title":"List workflows","openapi":"box-openapi.json GET /workflows","href":"/reference/get-workflows"},{"title":"Starts workflow based on request body","openapi":"box-openapi.json POST /workflows/{workflow_id}/start","href":"/reference/post-workflows-id-start"}]},{"group":"Zip Downloads","root":{"title":"Zip Downloads resources","href":"/reference/zip-downloads-resources"},"pages":[{"title":"Download zip archive","openapi":"box-openapi.json GET /zip_downloads/{zip_download_id}/content","href":"/reference/get-zip-downloads-id-content"},{"title":"Get zip download status","openapi":"box-openapi.json GET /zip_downloads/{zip_download_id}/status","href":"/reference/get-zip-downloads-id-status"},{"title":"Create zip download","openapi":"box-openapi.json POST /zip_downloads","href":"/reference/post-zip-downloads"}]}]},{"group":"v2025.0","pages":[{"group":"Archives","root":{"title":"Archives resources","href":"/reference/v2025.0/archives-resources"},"pages":[{"title":"List archives","openapi":"box-openapi-v2025.0.json GET /archives","href":"/reference/v2025.0/get-archives"},{"title":"Create archive","openapi":"box-openapi-v2025.0.json POST /archives","href":"/reference/v2025.0/post-archives"},{"title":"Update archive","openapi":"box-openapi-v2025.0.json PUT /archives/{archive_id}","href":"/reference/v2025.0/put-archives-id"},{"title":"Delete archive","openapi":"box-openapi-v2025.0.json DELETE /archives/{archive_id}","href":"/reference/v2025.0/delete-archives-id"}]},{"group":"Box Doc Gen","root":{"title":"Box Doc Gen resources","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}","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}","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","href":"/reference/v2025.0/get-docgen-jobs"},{"title":"Generate document using Box Doc Gen template","openapi":"box-openapi-v2025.0.json POST /docgen_batches","href":"/reference/v2025.0/post-docgen-batches"}]},{"group":"Box Doc Gen templates","root":{"title":"Box Doc Gen templates resources","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}","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}","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","href":"/reference/v2025.0/get-docgen-templates-id-tags"},{"title":"List Box Doc Gen templates","openapi":"box-openapi-v2025.0.json GET /docgen_templates","href":"/reference/v2025.0/get-docgen-templates"},{"title":"Create Box Doc Gen template","openapi":"box-openapi-v2025.0.json POST /docgen_templates","href":"/reference/v2025.0/post-docgen-templates"},{"title":"Delete Box Doc Gen template","openapi":"box-openapi-v2025.0.json DELETE /docgen_templates/{template_id}","href":"/reference/v2025.0/delete-docgen-templates-id"}]},{"group":"Box Hub Collaborations","root":{"title":"Box Hub Collaborations resources","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}","href":"/reference/v2025.0/get-hub-collaborations-id"},{"title":"Get Box Hub collaborations","openapi":"box-openapi-v2025.0.json GET /hub_collaborations","href":"/reference/v2025.0/get-hub-collaborations"},{"title":"Create Box Hub collaboration","openapi":"box-openapi-v2025.0.json POST /hub_collaborations","href":"/reference/v2025.0/post-hub-collaborations"},{"title":"Update Box Hub collaboration","openapi":"box-openapi-v2025.0.json PUT /hub_collaborations/{hub_collaboration_id}","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}","href":"/reference/v2025.0/delete-hub-collaborations-id"}]},{"group":"Box Hub Document","root":{"title":"Box Hub Document resources","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","href":"/reference/v2025.0/get-hub-document-blocks"},{"title":"List Hub Document Pages","openapi":"box-openapi-v2025.0.json GET /hub_document_pages","href":"/reference/v2025.0/get-hub-document-pages"}]},{"group":"Box Hub Items","root":{"title":"Box Hub Items resources","href":"/reference/v2025.0/hub-items-resources"},"pages":[{"title":"Get Box Hub items","openapi":"box-openapi-v2025.0.json GET /hub_items","href":"/reference/v2025.0/get-hub-items"},{"title":"Manage Box Hub items","openapi":"box-openapi-v2025.0.json POST /hubs/{hub_id}/manage_items","href":"/reference/v2025.0/post-hubs-id-manage-items"}]},{"group":"Box Hubs","root":{"title":"Box Hubs resources","href":"/reference/v2025.0/hubs-resources"},"pages":[{"title":"Get Box Hub information by ID","openapi":"box-openapi-v2025.0.json GET /hubs/{hub_id}","href":"/reference/v2025.0/get-hubs-id"},{"title":"List all Box Hubs","openapi":"box-openapi-v2025.0.json GET /hubs","href":"/reference/v2025.0/get-hubs"},{"title":"List all Box Hubs for requesting enterprise","openapi":"box-openapi-v2025.0.json GET /enterprise_hubs","href":"/reference/v2025.0/get-enterprise-hubs"},{"title":"Copy Box Hub","openapi":"box-openapi-v2025.0.json POST /hubs/{hub_id}/copy","href":"/reference/v2025.0/post-hubs-id-copy"},{"title":"Create Box Hub","openapi":"box-openapi-v2025.0.json POST /hubs","href":"/reference/v2025.0/post-hubs"},{"title":"Update Box Hub information by ID","openapi":"box-openapi-v2025.0.json PUT /hubs/{hub_id}","href":"/reference/v2025.0/put-hubs-id"},{"title":"Delete Box Hub","openapi":"box-openapi-v2025.0.json DELETE /hubs/{hub_id}","href":"/reference/v2025.0/delete-hubs-id"}]},{"group":"Enterprise Configurations","root":{"title":"Enterprise Configurations resources","href":"/reference/v2025.0/enterprise-configurations-resources"},"pages":[{"title":"Get enterprise configuration","openapi":"box-openapi-v2025.0.json GET /enterprise_configurations/{enterprise_id}","href":"/reference/v2025.0/get-enterprise-configurations-id"}]},{"group":"External Users","root":{"title":"External Users resources","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","href":"/reference/v2025.0/post-external-users-submit-delete-job"}]},{"group":"Shield lists","root":{"title":"Shield lists resources","href":"/reference/v2025.0/shield-lists-resources"},"pages":[{"title":"Get all shield lists in enterprise","openapi":"box-openapi-v2025.0.json GET /shield_lists","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}","href":"/reference/v2025.0/get-shield-lists-id"},{"title":"Create shield list","openapi":"box-openapi-v2025.0.json POST /shield_lists","href":"/reference/v2025.0/post-shield-lists"},{"title":"Update shield list","openapi":"box-openapi-v2025.0.json PUT /shield_lists/{shield_list_id}","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}","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","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","href":"/reference/v2026.0/post-automate-workflows-id-start"}]},{"group":"Convert to Box Note","root":{"title":"Convert to Box Note resources","href":"/reference/v2026.0/notes-resources"},"pages":[{"title":"Convert content to Box Note","openapi":"box-openapi-v2026.0.json POST /notes/convert","href":"/reference/v2026.0/post-notes-convert"}]},{"group":"Document Split","root":{"title":"Document Split resources","href":"/reference/v2026.0/document-split-resources"},"pages":[{"title":"Get Document Split job by ID","openapi":"box-openapi-v2026.0.json GET /document_splits/{document_split_id}","href":"/reference/v2026.0/get-document-splits-id"},{"title":"List Document Split jobs","openapi":"box-openapi-v2026.0.json GET /document_splits","href":"/reference/v2026.0/get-document-splits"},{"title":"Create Document Split job","openapi":"box-openapi-v2026.0.json POST /document_splits","href":"/reference/v2026.0/post-document-splits"}]},{"group":"Query","root":{"title":"Query resources","href":"/reference/v2026.0/query-resources"},"pages":[{"title":"Box Query","openapi":"box-openapi-v2026.0.json POST /query","href":"/reference/v2026.0/post-query"},{"title":"Create insights for Box items","openapi":"box-openapi-v2026.0.json POST /query_insights","href":"/reference/v2026.0/post-query-insights"}]},{"group":"Shuttle","root":{"title":"Shuttle resources","href":"/reference/v2026.0/shuttle-resources"},"pages":[{"title":"Get shuttle job by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_jobs/{shuttle_job_id}","href":"/reference/v2026.0/get-shuttle-jobs-id"},{"title":"Get shuttle job schedule","openapi":"box-openapi-v2026.0.json GET /shuttle_job_schedules/{shuttle_job_schedule_id}","href":"/reference/v2026.0/get-shuttle-job-schedules-id"},{"title":"Get shuttle path mapping by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_path_mappings/{shuttle_path_mapping_id}","href":"/reference/v2026.0/get-shuttle-path-mappings-id"},{"title":"Get shuttle report by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_reports/{shuttle_report_id}","href":"/reference/v2026.0/get-shuttle-reports-id"},{"title":"Get shuttle run by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_runs/{shuttle_run_id}","href":"/reference/v2026.0/get-shuttle-runs-id"},{"title":"Get shuttle subject mapping by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_subject_mappings/{shuttle_subject_mapping_id}","href":"/reference/v2026.0/get-shuttle-subject-mappings-id"},{"title":"Get shuttle system by ID","openapi":"box-openapi-v2026.0.json GET /shuttle_systems/{shuttle_system_id}","href":"/reference/v2026.0/get-shuttle-systems-id"},{"title":"List shuttle discovered subjects","openapi":"box-openapi-v2026.0.json GET /shuttle_discovered_subjects","href":"/reference/v2026.0/get-shuttle-discovered-subjects"},{"title":"List shuttle job schedules","openapi":"box-openapi-v2026.0.json GET /shuttle_job_schedules","href":"/reference/v2026.0/get-shuttle-job-schedules"},{"title":"List shuttle jobs","openapi":"box-openapi-v2026.0.json GET /shuttle_jobs","href":"/reference/v2026.0/get-shuttle-jobs"},{"title":"List shuttle mapping errors","openapi":"box-openapi-v2026.0.json GET /shuttle_mapping_errors","href":"/reference/v2026.0/get-shuttle-mapping-errors"},{"title":"List shuttle path entries","openapi":"box-openapi-v2026.0.json GET /shuttle_path_entries","href":"/reference/v2026.0/get-shuttle-path-entries"},{"title":"List shuttle path mappings","openapi":"box-openapi-v2026.0.json GET /shuttle_path_mappings","href":"/reference/v2026.0/get-shuttle-path-mappings"},{"title":"List shuttle reports","openapi":"box-openapi-v2026.0.json GET /shuttle_reports","href":"/reference/v2026.0/get-shuttle-reports"},{"title":"List shuttle runs","openapi":"box-openapi-v2026.0.json GET /shuttle_runs","href":"/reference/v2026.0/get-shuttle-runs"},{"title":"List shuttle subject mappings","openapi":"box-openapi-v2026.0.json GET /shuttle_subject_mappings","href":"/reference/v2026.0/get-shuttle-subject-mappings"},{"title":"List shuttle systems","openapi":"box-openapi-v2026.0.json GET /shuttle_systems","href":"/reference/v2026.0/get-shuttle-systems"},{"title":"Create shuttle job","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs","href":"/reference/v2026.0/post-shuttle-jobs"},{"title":"Create shuttle job schedule","openapi":"box-openapi-v2026.0.json POST /shuttle_job_schedules","href":"/reference/v2026.0/post-shuttle-job-schedules"},{"title":"Create shuttle path mapping","openapi":"box-openapi-v2026.0.json POST /shuttle_path_mappings","href":"/reference/v2026.0/post-shuttle-path-mappings"},{"title":"Create shuttle path mapping import","openapi":"box-openapi-v2026.0.json POST /shuttle_path_mapping_imports","href":"/reference/v2026.0/post-shuttle-path-mapping-imports"},{"title":"Create shuttle report","openapi":"box-openapi-v2026.0.json POST /shuttle_reports","href":"/reference/v2026.0/post-shuttle-reports"},{"title":"Create shuttle subject mapping","openapi":"box-openapi-v2026.0.json POST /shuttle_subject_mappings","href":"/reference/v2026.0/post-shuttle-subject-mappings"},{"title":"Create shuttle subject mapping import","openapi":"box-openapi-v2026.0.json POST /shuttle_subject_mapping_imports","href":"/reference/v2026.0/post-shuttle-subject-mapping-imports"},{"title":"Create shuttle system","openapi":"box-openapi-v2026.0.json POST /shuttle_systems","href":"/reference/v2026.0/post-shuttle-systems"},{"title":"Issue registration token for Windows system","openapi":"box-openapi-v2026.0.json POST /shuttle_systems/{shuttle_system_id}/issue_registration_token","href":"/reference/v2026.0/post-shuttle-systems-id-issue-registration-token"},{"title":"Prepare migration","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs/{shuttle_job_id}/prepare_migration","href":"/reference/v2026.0/post-shuttle-jobs-id-prepare-migration"},{"title":"Start shuttle job","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs/{shuttle_job_id}/start","href":"/reference/v2026.0/post-shuttle-jobs-id-start"},{"title":"Stop shuttle job","openapi":"box-openapi-v2026.0.json POST /shuttle_jobs/{shuttle_job_id}/stop","href":"/reference/v2026.0/post-shuttle-jobs-id-stop"},{"title":"Update shuttle job","openapi":"box-openapi-v2026.0.json PUT /shuttle_jobs/{shuttle_job_id}","href":"/reference/v2026.0/put-shuttle-jobs-id"},{"title":"Update shuttle job schedule","openapi":"box-openapi-v2026.0.json PUT /shuttle_job_schedules/{shuttle_job_schedule_id}","href":"/reference/v2026.0/put-shuttle-job-schedules-id"},{"title":"Update shuttle path mapping","openapi":"box-openapi-v2026.0.json PUT /shuttle_path_mappings/{shuttle_path_mapping_id}","href":"/reference/v2026.0/put-shuttle-path-mappings-id"},{"title":"Update shuttle subject mapping","openapi":"box-openapi-v2026.0.json PUT /shuttle_subject_mappings/{shuttle_subject_mapping_id}","href":"/reference/v2026.0/put-shuttle-subject-mappings-id"},{"title":"Update shuttle system","openapi":"box-openapi-v2026.0.json PUT /shuttle_systems/{shuttle_system_id}","href":"/reference/v2026.0/put-shuttle-systems-id"},{"title":"Delete shuttle job","openapi":"box-openapi-v2026.0.json DELETE /shuttle_jobs/{shuttle_job_id}","href":"/reference/v2026.0/delete-shuttle-jobs-id"},{"title":"Delete shuttle job schedule","openapi":"box-openapi-v2026.0.json DELETE /shuttle_job_schedules/{shuttle_job_schedule_id}","href":"/reference/v2026.0/delete-shuttle-job-schedules-id"},{"title":"Delete shuttle path mapping","openapi":"box-openapi-v2026.0.json DELETE /shuttle_path_mappings/{shuttle_path_mapping_id}","href":"/reference/v2026.0/delete-shuttle-path-mappings-id"},{"title":"Delete shuttle subject mapping","openapi":"box-openapi-v2026.0.json DELETE /shuttle_subject_mappings/{shuttle_subject_mapping_id}","href":"/reference/v2026.0/delete-shuttle-subject-mappings-id"},{"title":"Delete shuttle system","openapi":"box-openapi-v2026.0.json DELETE /shuttle_systems/{shuttle_system_id}","href":"/reference/v2026.0/delete-shuttle-systems-id"}]}]}]},{"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"}},"pages":[{"title":"ja","href":"/ja/reference/get-recent-items"}]}]},"title":"List recently accessed items - Box Dev Docs","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-CJDb0dYK.js","dist-Cv_O2fky.js","lib--scc4DXi.js","lib-B8HbPgcC.js","clsx-BGBGWFTt.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","AssistantPageLink-2C5OB2eV.js"]}