Link Previews unfurl authenticated content in Notion when users paste supported links from selected partner services.When a user pastes a supported link, Notion can ask the user to authenticate with the source service. The service can then unfurl content in a link preview block, which can include text, statuses, iFrames, and media.
An illustrative example of how link previews function.
Custom Link Preview connections are no longer available for new developers to create. Existing supported Link Preview integrations continue to work for Notion users.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Notion Docs","colors":{"primary":"#000","light":"#097fe8","dark":"#0075de"},"logo":{"light":"https://mintcdn.com/notion-demo/5YdhSbldE14t5Rna/logo/light.svg?fit=max\u0026auto=format\u0026n=5YdhSbldE14t5Rna\u0026q=85\u0026s=249f5693ad929397409bf9b51d6d539d","dark":"https://mintcdn.com/notion-demo/5YdhSbldE14t5Rna/logo/dark.svg?fit=max\u0026auto=format\u0026n=5YdhSbldE14t5Rna\u0026q=85\u0026s=a8404879d171debac543bb6c1482c909","href":"/"},"favicon":"https://mintcdn.com/notion-demo/LHm9qfrJYJOPRxs6/favicon.png?fit=max\u0026auto=format\u0026n=LHm9qfrJYJOPRxs6\u0026q=85\u0026s=0668f0b3334eef21f0cdc65b390d22d9","api":{"openapi":["openapi.json","openapi-undocumented.json","openapi-adminApi.json"]},"appearance":{"default":"system"},"background":{"color":{"light":"#ffffff","dark":"#0f0f0f"}},"navbar":{"links":[{"href":"https://www.notion.com/login","label":"Log in"}],"primary":{"type":"button","label":"Developer portal","href":"https://www.notion.so/developers"}},"footer":{"socials":{"x":"https://x.com/NotionDevs","slack":"https://join.slack.com/t/notiondevs/shared_invite/zt-3u9oid9q8-HLUBmMVWYK~g9HFo4U4raA"}},"seo":{"metatags":{"og:image":"/images/og-image.png"}},"fonts":{"family":"NotionInter"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"notion-demo","hasAudioNarration":false,"actualSubdomain":"notion-demo","customDomains":["developers.notion.com"],"gitSource":{"type":"github","owner":"makenotion","repo":"notion-next","deployBranch":"main","contentDirectory":"src/server-publicApiDocs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aebda3da63933462e29e50c","collectionId":"6fe53d48-0b2f-46f7-899a-8aab639875d3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aebda3da63933462e29e50c"},"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":"6aed571c48a600c03b6277ac","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":140},{"language":"default","tag":"Endpoints","count":133},{"language":"default","tag":"Guides","count":62},{"language":"default","tag":"Admin API","count":58},{"language":"default","tag":"Webhook events","count":31},{"language":"default","tag":"Agents","count":23},{"language":"default","tag":"Objects","count":18},{"language":"default","tag":"Notion API","count":17},{"language":"default","tag":"Data APIs","count":17},{"language":"default","tag":"Pages","count":17}]},"assistantConfig":{},"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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"NotionInter\";font-weight:400;font-style:normal;font-display:optional;src:url(\"/fonts/NotionInter-Regular.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:500;font-style:normal;font-display:optional;src:url(\"/fonts/NotionInter-Medium.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:600;font-style:normal;font-display:optional;src:url(\"/fonts/NotionInter-SemiBold.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:700;font-style:normal;font-display:optional;src:url(\"/fonts/NotionInter-Bold.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:400;font-style:italic;font-display:optional;src:url(\"/fonts/NotionInter-Italic.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:500;font-style:italic;font-display:optional;src:url(\"/fonts/NotionInter-MediumItalic.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:600;font-style:italic;font-display:optional;src:url(\"/fonts/NotionInter-SemiBoldItalic.woff2\") format(\"woff2\")}@font-face{font-family:\"NotionInter\";font-weight:700;font-style:italic;font-display:optional;src:url(\"/fonts/NotionInter-BoldItalic.woff2\") format(\"woff2\")}:root{--font-notion-stack:\n\t\t\"NotionInter\", \"Inter\", -apple-system, \"system-ui\", \"Segoe UI\", Helvetica,\n\t\tArial, sans-serif, \"Apple Color Emoji\", \"Segoe UI Emoji\", \"Segoe UI Symbol\"}html,body,button,input,select,textarea,h1,h2,h3,h4,h5,h6{font-family:var(--font-notion-stack)}.card>.flex.items-center:has([data-component-part=\"card-icon\"]){align-items:flex-start}[data-component-part=\"card-content\"]{font-size:0.875rem;line-height:1.45}.navbar-link>a{background-color:transparent!important}.navbar-link>a:hover{background-color:#37352f0a!important}html.dark .navbar-link>a:hover{background-color:rgba(255, 255, 255, 0.055)!important}.bg-primary-dark.rounded-xl{border-radius:8px!important}#search-bar-entry{background-color:#37352f0a!important;color:#7d7a75!important}#search-bar-entry:hover{background-color:#37352f1a!important}#search-bar-entry svg{color:#7d7a75!important}#search-bar-entry:hover svg{color:#37352f!important}html.dark #search-bar-entry{background-color:rgba(255, 255, 255, 0.055)!important;color:rgba(255, 255, 255, 0.5)!important}html.dark #search-bar-entry:hover{background-color:rgba(255, 255, 255, 0.129)!important}html.dark #search-bar-entry svg{color:rgba(255, 255, 255, 0.5)!important}html.dark #search-bar-entry:hover svg{color:#ffffff!important}#search-bar-entry-mobile,#search-bar-entry-mobile svg{color:#7d7a75!important;background-color:#7d7a75!important}#search-bar-entry-mobile:hover,#search-bar-entry-mobile:hover svg{color:#37352f!important;background-color:#37352f!important}html.dark #search-bar-entry-mobile,html.dark #search-bar-entry-mobile svg{color:rgba(255, 255, 255, 0.5)!important;background-color:rgba(255, 255, 255, 0.5)!important}html.dark #search-bar-entry-mobile:hover,html.dark #search-bar-entry-mobile:hover svg{color:#ffffff!important;background-color:#ffffff!important}button[data-component-part=\"theme-preference-menu-trigger\"]{background-color:#37352f0a!important}button[data-component-part=\"theme-preference-menu-trigger\"]:hover,button[data-component-part=\"theme-preference-menu-trigger\"][aria-expanded=\"true\"]{background-color:#37352f1a!important}html.dark button[data-component-part=\"theme-preference-menu-trigger\"]{background-color:rgba(255, 255, 255, 0.055)!important}html.dark button[data-component-part=\"theme-preference-menu-trigger\"]:hover,html.dark button[data-component-part=\"theme-preference-menu-trigger\"][aria-expanded=\"true\"]{background-color:rgba(255, 255, 255, 0.129)!important}button[data-component-part=\"theme-preference-menu-trigger\"] svg{color:#7d7a75!important}button[data-component-part=\"theme-preference-menu-trigger\"]:hover svg,button[data-component-part=\"theme-preference-menu-trigger\"][aria-expanded=\"true\"] svg{color:#37352f!important}html.dark button[data-component-part=\"theme-preference-menu-trigger\"] svg{color:rgba(255, 255, 255, 0.5)!important}html.dark button[data-component-part=\"theme-preference-menu-trigger\"]:hover svg,html.dark button[data-component-part=\"theme-preference-menu-trigger\"][aria-expanded=\"true\"] svg{color:#ffffff!important}#navbar [class*=\"border-gray-100\"]{border-color:#e6e5e3!important}html.dark #navbar [class*=\"border-gray-800\"]{border-color:rgba(255, 255, 255, 0.094)!important}.nav-tabs-item div[class*=\"bg-gray-200\"]{background-color:#e6e5e3!important}html.dark .nav-tabs-item div[class*=\"bg-gray-700\"]{background-color:rgba(255, 255, 255, 0.18)!important}#sidebar-content[class*=\"border-gray-100\"]{border-color:#e6e5e3!important}html.dark #sidebar-content[class*=\"border-white\"]{border-color:rgba(255, 255, 255, 0.094)!important}.sidebar-nav-group-divider{background-color:#e6e5e3!important}html.dark .sidebar-nav-group-divider{background-color:rgba(255, 255, 255, 0.094)!important}html:not(.dark) :is(a,button)[class*=\"outline-offset\"][class*=\"text-gray-700\"]{color:#37352f!important}html:not(.dark) :is(a,button)[class*=\"outline-offset\"][class*=\"hover:text-gray-900\"]:hover{color:#37352f!important}html:not(.dark) :is(a,button)[class*=\"outline-offset\"] svg[class*=\"text-gray-400\"][class*=\"group-hover:text-gray-600\"]{color:#ada9a3!important}html:not(.dark) :is(a,button)[class*=\"outline-offset\"]:hover svg[class*=\"text-gray-400\"][class*=\"group-hover:text-gray-600\"]{color:#7d7a75!important}html.dark :is(a,button)[class*=\"outline-offset\"] svg[class*=\"text-gray-400\"][class*=\"group-hover:text-gray-600\"]{color:#7d7a75!important}html.dark :is(a,button)[class*=\"outline-offset\"]:hover svg[class*=\"text-gray-400\"][class*=\"group-hover:text-gray-600\"]{color:#ada9a3!important}.card[class*=\"border-gray-950\"]{border-color:#e6e5e3!important}html.dark .card[class*=\"border-white\"]{border-color:rgba(255, 255, 255, 0.094)!important}[data-component-part=\"card-title\"]{color:#37352f!important}html.dark [data-component-part=\"card-title\"]{color:#ffffff!important}[data-component-part=\"card-content\"]{color:#7d7a75!important}html.dark [data-component-part=\"card-content\"]{color:#ada9a3!important}:is(a,button)[class*=\"outline-offset\"][class*=\"rounded-xl\"]{border-radius:6px!important}a[class*=\"text-shadow\"]{text-shadow:none!important;font-weight:600!important}.sidebar-group :is(a,button,span){hyphens:none!important}html.dark :is(a,button)[class*=\"outline-offset\"][class*=\"text-primary-light\"]{color:#ffffff!important}html.dark :is(a,button)[class*=\"outline-offset\"][class*=\"bg-primary-light\"]{background-color:rgba(255, 255, 255, 0.129)!important}:is(a,button)[class*=\"outline-offset\"][class*=\"bg-primary/10\"]{background-color:#37352f1a!important}:is(a,button)[class*=\"outline-offset\"][class*=\"hover:bg-gray-600\"]:hover{background-color:#37352f0a!important}html.dark :is(a,button)[class*=\"outline-offset\"][class*=\"hover:bg-gray-200\"]:hover{background-color:rgba(255, 255, 255, 0.055)!important}html.dark #table-of-contents-content li[data-active],html.dark #table-of-contents-content li[data-active]>a{border-color:#ffffff!important}html.dark #table-of-contents-content li[data-active]>a{color:#ffffff!important}html.dark a.nav-tabs-item[class*=\"text-primary\"]{color:#ffffff!important}html.dark a.nav-tabs-item div[class*=\"bg-primary-light\"]{background-color:#ffffff!important}.eyebrow{color:#78736f!important}html.dark .eyebrow{color:#a3a39e!important}html:is([data-current-path=\"/page/changelog\"],[data-current-path=\"/page/examples\"]) #sidebar-content{display:none!important}html:is([data-current-path=\"/page/changelog\"],[data-current-path=\"/page/examples\"]) #content-container{max-width:none!important;margin-left:0!important}html:is([data-current-path=\"/page/changelog\"],[data-current-path=\"/page/examples\"]) #content-area{margin-left:0!important;margin-right:0!important}html[data-current-path=\"/page/changelog\"] [data-component-part=\"update-content\"]{font-size:1rem}.sidebar-group-header{color:#78736f!important}html.dark .sidebar-group-header{color:#a3a39e!important}html.dark [class*=\"prose-invert\"]{color:#c7c7c7!important;--tw-prose-invert-body: #c7c7c7 !important;--tw-prose-invert-bullets: #c7c7c7 !important;--tw-prose-invert-counters: #c7c7c7 !important}html.dark h1#page-title{color:#ffffff!important}html.dark #header p{color:#c7c7c7!important}html.dark #table-of-contents-content a{color:#c7c7c7!important}html.dark .sidebar-group a:not([class*=\"text-shadow\"]),html.dark .sidebar-group button{color:#c7c7c7!important}html.dark #table-of-contents-content a:hover,html.dark .sidebar-group a:not([class*=\"text-shadow\"]):hover,html.dark .sidebar-group button:hover,html.dark a.nav-tabs-item:hover{color:#ffffff!important}#content a.link{color:inherit!important;text-decoration:underline!important;text-decoration-color:rgba(55, 53, 47, 0.25)!important;text-underline-offset:3px!important;text-decoration-thickness:1px!important;border-bottom:0!important;font-weight:inherit!important}#content a.link:hover{color:inherit!important;text-decoration-color:currentColor!important}html.dark #content a.link{text-decoration-color:rgba(255, 255, 255, 0.25)!important}html.dark #content a.link:hover{text-decoration-color:currentColor!important}.callout[class*=\"bg-blue\"]{background-color:#e5f2fc!important;border-color:#b6d4f3!important}.callout[class*=\"bg-blue\"] [data-component-part=\"callout-icon\"],.callout[class*=\"bg-blue\"] [data-component-part=\"callout-icon\"] svg{color:#2783de!important}.callout[class*=\"bg-blue\"] [data-component-part=\"callout-content\"]{color:#355f8b!important}.callout[class*=\"bg-green\"]{background-color:#e8f1ec!important;border-color:#bed9c9!important}.callout[class*=\"bg-green\"] [data-component-part=\"callout-icon\"],.callout[class*=\"bg-green\"] [data-component-part=\"callout-icon\"] svg{color:#46a171!important}.callout[class*=\"bg-green\"] [data-component-part=\"callout-content\"]{color:#37674c!important}.callout[class*=\"bg-yellow\"]{background-color:#f9f3dc!important;border-color:#e8d497!important}.callout[class*=\"bg-yellow\"] [data-component-part=\"callout-icon\"],.callout[class*=\"bg-yellow\"] [data-component-part=\"callout-icon\"] svg{color:#d8a32f!important}.callout[class*=\"bg-yellow\"] [data-component-part=\"callout-content\"]{color:#836426!important}.callout[class*=\"bg-red\"]{background-color:#fce9e7!important;border-color:#f0c5be!important}.callout[class*=\"bg-red\"] [data-component-part=\"callout-icon\"],.callout[class*=\"bg-red\"] [data-component-part=\"callout-icon\"] svg{color:#e56458!important}.callout[class*=\"bg-red\"] [data-component-part=\"callout-content\"]{color:#924943!important}.callout[class*=\"bg-neutral\"]{background-color:#f0efed!important;border-color:#e6e5e3!important}.callout[class*=\"bg-neutral\"] [data-component-part=\"callout-icon\"],.callout[class*=\"bg-neutral\"] [data-component-part=\"callout-icon\"] svg{color:#5f5e59!important}.callout[class*=\"bg-neutral\"] [data-component-part=\"callout-content\"]{color:#494846!important}html.dark .callout[class*=\"bg-blue\"]{background-color:rgba(39, 131, 222, 0.12)!important;border-color:rgba(39, 131, 222, 0.3)!important}html.dark .callout[class*=\"bg-green\"]{background-color:rgba(70, 161, 113, 0.12)!important;border-color:rgba(70, 161, 113, 0.3)!important}html.dark .callout[class*=\"bg-yellow\"]{background-color:rgba(216, 163, 47, 0.12)!important;border-color:rgba(216, 163, 47, 0.3)!important}html.dark .callout[class*=\"bg-red\"]{background-color:rgba(229, 100, 88, 0.12)!important;border-color:rgba(229, 100, 88, 0.3)!important}html.dark .callout[class*=\"bg-neutral\"]{background-color:rgba(255, 255, 255, 0.05)!important;border-color:rgba(255, 255, 255, 0.12)!important}html.dark .callout[class*=\"bg-blue\"] [data-component-part=\"callout-content\"]{color:#9dc0ea!important}html.dark .callout[class*=\"bg-green\"] [data-component-part=\"callout-content\"]{color:#a6c7b4!important}html.dark .callout[class*=\"bg-yellow\"] [data-component-part=\"callout-content\"]{color:#e2ca88!important}html.dark .callout[class*=\"bg-red\"] [data-component-part=\"callout-content\"]{color:#e0aea6!important}html.dark .callout[class*=\"bg-neutral\"] [data-component-part=\"callout-content\"]{color:#bcbab6!important}html.dark .callout[class*=\"bg-neutral\"] [data-component-part=\"callout-icon\"],html.dark .callout[class*=\"bg-neutral\"] [data-component-part=\"callout-icon\"] svg{color:#ada9a3!important}.callout a.link,#content .callout a.link{color:inherit!important;text-decoration:underline!important;border-bottom:0!important}.callout a.link:hover,#content .callout a.link:hover{color:inherit!important;text-decoration:underline!important}[data-component-part=\"card-icon\"] img{filter:brightness(0) saturate(100%) invert(31%) sepia(85%) saturate(2280%)\n\t\thue-rotate(196deg) brightness(96%) contrast(101%)}html.dark [data-component-part=\"card-icon\"] img{filter:brightness(0) saturate(100%) invert(45%) sepia(98%) saturate(1480%)\n\t\thue-rotate(196deg) brightness(101%) contrast(96%)}[data-component-part=\"card-icon\"]>svg{width:1.25rem!important;height:1.25rem!important;mask-size:contain!important;-webkit-mask-size:contain!important}.card{transition:box-shadow 180ms ease-out,\n\t\tborder-color 180ms ease-out}.card:hover{--tw-ring-shadow: 0 0 #0000 !important;--tw-ring-color: transparent !important;border-color:transparent!important;box-shadow:0 0 0 1px rgba(0, 0, 0, 0.06),\n\t\t0 4px 10px rgba(15, 15, 15, 0.05),\n\t\t0 1px 3px rgba(15, 15, 15, 0.04)!important}html.dark .card:hover{--tw-ring-shadow: 0 0 #0000 !important;--tw-ring-color: transparent !important;border-color:rgba(255, 255, 255, 0.18)!important;box-shadow:none!important}a[class*=\"border-gray-200/70\"][class*=\"rounded-xl\"][class*=\"py-3\"][class*=\"px-4\"]{border:0!important;padding:0!important}[data-component-part=\"code-block-root\"],[data-component-part=\"code-block-root\"] pre,[data-component-part=\"code-block-root\"] code,[data-component-part=\"code-block-root\"] code *{font-size:12px!important;line-height:20px!important}#page-context-menu [class*=\"rounded-l-xl\"]{border-radius:6px 0 0 6px!important}#page-context-menu [class*=\"rounded-r-xl\"]{border-radius:0 6px 6px 0!important}#page-context-menu [class*=\"text-sm\"]{font-size:12px!important}#page-context-menu :is(button,a)[class*=\"bg-gray\"],#page-context-menu :is(button,a)[class*=\"border-gray\"]{background-color:transparent!important;border-color:#e6e5e3!important}#page-context-menu :is(button,a):hover{background-color:#37352f0a!important}html.dark #page-context-menu :is(button,a)[class*=\"bg-gray\"],html.dark #page-context-menu :is(button,a)[class*=\"border-gray\"]{border-color:rgba(255, 255, 255, 0.094)!important}html.dark #page-context-menu :is(button,a):hover{background-color:rgba(255, 255, 255, 0.055)!important}[data-component-part=\"update-label\"]{background-color:#f7f6f3!important;color:#5f5e59!important;font-size:14px!important;line-height:20px!important;font-weight:400!important}html.dark [data-component-part=\"update-label\"]{background-color:rgba(255, 255, 255, 0.04)!important;color:#bcbab6!important}[class*=\"text-tooltip-foreground\"]{background-color:#1f1f1d!important;color:#ffffff!important;border-color:#1f1f1d!important}"}],"page":{"pagePath":"page/link-previews-api","slug":"/page/link-previews-api","pageMetadata":{"title":"Link Previews API","description":null,"href":"/page/link-previews-api"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{Frame,Heading,OptimizedImage}=_components;if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=0aeb90580556397b1c6bd0334db3b60c`,alt:`1269`,\"data-og-width\":`1269`,width:`1269`,\"data-og-height\":`322`,height:`322`,\"data-path\":`images/page/9847222-Group_696.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?w=280\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=a654a332e77ddb17e45ab0f793f666ec 280w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?w=560\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=0f4aa1c31006c59012a3b498642b2a1e 560w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?w=840\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=9fc6700328336c1b72ca8d3965f33833 840w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=29454fd810fe5d8bb491652775c38840 1100w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=1c74655689251d805b433aa1d64719cf 1650w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/9847222-Group_696.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=8bf6db63fdb94d76fab743c7f3593422 2500w`})}),`\n`,_jsx(_components.p,{children:`Link Previews unfurl authenticated content in Notion when users paste supported links from selected partner services.`}),`\n`,_jsx(_components.p,{children:`When a user pastes a supported link, Notion can ask the user to authenticate with the source service. The service can then unfurl content in a link preview block, which can include text, statuses, iFrames, and media.`}),`\n`,_jsx(Frame,{caption:`An illustrative example of how link previews function.`,children:_jsx(OptimizedImage,{src:`https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=426cbeab290e325c7fc0cc49199ffe39`,alt:`1228`,\"data-og-width\":`1228`,width:`1228`,\"data-og-height\":`944`,height:`944`,\"data-path\":`images/page/a075de5-Group_698.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?w=280\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=f95d32e28cab049be206d5fada3cdffc 280w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?w=560\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=cff76df00cbc0c4b2c37fc8e76cd253e 560w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?w=840\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=2d59390c5a555864e9bee7d3871c7b85 840w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=dde8469f87e6295ddcffb8171bee4e55 1100w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=f8321a95eeb0fd0df5ec2a26792ac935 1650w, https://mintcdn.com/notion-demo/Muj7K3D7I6gj-QAA/images/page/a075de5-Group_698.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Muj7K3D7I6gj-QAA\u0026q=85\u0026s=d3119cad0e1089a50ef85c34c429f389 2500w`})}),`\n`,_jsx(Heading,{level:`2`,id:`availability`,children:`Availability`}),`\n`,_jsx(_components.p,{children:`Custom Link Preview connections are no longer available for new developers to create. Existing supported Link Preview integrations continue to work for Notion users.`})]})}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":"Link Previews API","description":null,"href":"/page/link-previews-api"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Availability","slug":"availability","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/notion-demo/f3af24179eebc764/mcp-section-label.js","/_mintlify/custom/notion-demo/96b92b5a9cb7e11c/mcp-tool-section-redirects.js"],"subdomain":"notion-demo","siteName":"Notion Docs","title":"Link Previews API - Notion Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T01:59:30.052Z","originalFileLocation":"page/link-previews-api.mdx"},"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=\"application-name\" content=\"Notion 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/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_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/notion-demo/1PaJq9z3waub4TpE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Link Previews API - Notion Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Notion Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.notion.com/page/link-previews-api\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://notion-demo.mintlify.site/images/og-image.png\">\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=\"Link Previews API - Notion Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://notion-demo.mintlify.site/images/og-image.png\">\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/notion-demo/1PaJq9z3waub4TpE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Notion Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.notion.com/page/link-previews-api\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/page/link-previews-api.md\">","siteName":"Notion Docs","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","groups":[{"group":"Notion API","pages":[{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/guides/notion-api/quick-start"},{"group":"Connections and tokens","root":{"title":"Connections and tokens","sidebarTitle":"Connections and tokens","href":"/guides/connections-and-tokens/overview"},"pages":[{"title":"Personal access tokens","href":"/guides/connections-and-tokens/personal-access-tokens"},{"title":"Internal connections","href":"/guides/connections-and-tokens/internal-connections"},{"group":"OAuth integrations","root":{"title":"OAuth integrations","href":"/guides/connections-and-tokens/oauth-integrations/overview"},"pages":[{"title":"Set up content for users","sidebarTitle":"Set up content for users","href":"/guides/connections-and-tokens/oauth-integrations/preparing-for-users"}]},{"group":"Public integrations","root":{"title":"Public integrations","href":"/guides/connections-and-tokens/public-integrations/overview"},"pages":[{"title":"List on the Marketplace","href":"/guides/connections-and-tokens/public-integrations/marketplace-listing"}]}]},{"group":"Authorization","root":{"title":"Authorization","href":"/guides/authorization/overview"},"pages":[{"title":"Secure API credentials","sidebarTitle":"API credential security","href":"/guides/authorization/credential-security"}]},{"group":"Developer tools","root":{"title":"Developer tools","href":"/guides/developer-tools/overview"},"pages":[{"title":"Connection health","href":"/guides/developer-tools/connection-health"}]}]},{"group":"Notion MCP","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/guides/mcp/overview"},{"group":"Connect to Notion MCP","root":{"title":"Connect to Notion MCP","href":"/guides/mcp/get-started-with-mcp"},"pages":[{"title":"Build an MCP client for Notion","href":"/guides/mcp/build-mcp-client"}]},{"group":"Supported tools","root":{"title":"Supported tools","href":"/guides/mcp/mcp-supported-tools"},"pages":[{"group":"Search and read information","root":{"title":"Search and read information","href":"/guides/mcp/tools-search"},"pages":[{"title":"Search and read information — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-search-reference"}]},{"group":"Work together in Notion","root":{"title":"Work together in Notion","href":"/guides/mcp/tools-comments"},"pages":[{"title":"Work together in Notion — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-comments-reference"}]},{"group":"Create and organize pages","root":{"title":"Create and organize pages","href":"/guides/mcp/tools-pages"},"pages":[{"title":"Create and organize pages — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-pages-reference"}]},{"group":"Manage databases and views","root":{"title":"Manage databases and views","href":"/guides/mcp/tools-databases"},"pages":[{"title":"Manage databases and views — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-databases-reference"}]},{"group":"Work with files","root":{"title":"Work with files","href":"/guides/mcp/tools-files"},"pages":[{"title":"Work with files — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-files-reference"}]},{"group":"Reuse instructions and delegate work","root":{"title":"Reuse instructions and delegate work","href":"/guides/mcp/tools-skills-agents"},"pages":[{"title":"Reuse instructions and delegate work — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-skills-agents-reference"}]},{"group":"Manage your time","root":{"title":"Manage your time","href":"/guides/mcp/tools-calendars"},"pages":[{"title":"Manage your time — technical reference","sidebarTitle":"Technical reference","href":"/guides/mcp/tools-calendars-reference"}]},{"title":"Notion MCP tool FAQs","sidebarTitle":"FAQs and troubleshooting","href":"/guides/mcp/tools-faqs"},{"title":"Notion MCP rate limits","sidebarTitle":"Rate limits","href":"/guides/mcp/rate-limits"}]},{"title":"Use Notion Skills with MCP","sidebarTitle":"Skills via MCP","href":"/guides/mcp/notion-skills"},{"title":"Enterprise-managed authorization","sidebarTitle":"Enterprise-managed authorization","href":"/guides/mcp/enterprise-managed-authorization"},{"title":"Security best practices","href":"/guides/mcp/mcp-security-best-practices"}]},{"group":"Agent APIs","pages":[{"group":"Notion Agent APIs","pages":[{"title":"Overview","href":"/guides/notion-agent-apis/overview"},{"title":"Quickstart","sidebarTitle":"Quickstart","href":"/guides/notion-agent-apis/quickstart"},{"title":"Upgrading from the alpha routes","href":"/guides/notion-agent-apis/upgrading-to-public-beta"}]},{"group":"Agent Skills API","pages":[{"title":"Agent Skills API","sidebarTitle":"Overview","href":"/guides/agent-skills/overview"}]}]},{"group":"API versions","pages":[{"group":"Upgrading to 2026-03-11","pages":[{"title":"Upgrade guide","sidebarTitle":"Upgrade guide","href":"/guides/get-started/upgrade-guide-2026-03-11"}]},{"group":"Upgrading to 2025-09-03","pages":[{"title":"Upgrade guide","sidebarTitle":"Upgrade guide","href":"/guides/get-started/upgrade-guide-2025-09-03"},{"title":"FAQs","href":"/guides/get-started/upgrade-faqs-2025-09-03"}]}]},{"group":"Data APIs","pages":[{"title":"Working with page content","href":"/guides/data-apis/working-with-page-content"},{"title":"Read every item in a page property","sidebarTitle":"Read page properties","href":"/guides/data-apis/read-page-property-values"},{"group":"Working with databases","pages":[{"title":"Working with databases","sidebarTitle":"Overview","href":"/guides/data-apis/working-with-databases"},{"title":"Create a page in a data source","sidebarTitle":"Create a page","href":"/guides/data-apis/create-pages-in-a-data-source"},{"title":"Query large data sources","sidebarTitle":"Large data sources","href":"/guides/data-apis/query-large-data-sources"},{"title":"Creating pages from templates","href":"/guides/data-apis/creating-pages-from-templates"}]},{"title":"Working with views","href":"/guides/data-apis/working-with-views"},{"title":"Working with comments","href":"/guides/data-apis/working-with-comments"},{"group":"Working with markdown content","pages":[{"title":"Working with markdown content","href":"/guides/data-apis/working-with-markdown-content"},{"title":"Migrate to Notion-flavored Markdown (v2)","sidebarTitle":"Migrate to v2","href":"/guides/data-apis/migrate-to-notion-flavored-markdown"},{"title":"Enhanced markdown format (v1, deprecated)","href":"/guides/data-apis/enhanced-markdown"},{"title":"Notion-flavored Markdown format","href":"/guides/data-apis/notion-flavored-markdown"}]},{"group":"Working with files and media","pages":[{"title":"Working with files and media","sidebarTitle":"Overview","href":"/guides/data-apis/working-with-files-and-media"},{"title":"Uploading small files","href":"/guides/data-apis/uploading-small-files"},{"title":"Retrieving existing files","href":"/guides/data-apis/retrieving-files"},{"title":"Uploading larger files","href":"/guides/data-apis/sending-larger-files"},{"title":"Importing external files","href":"/guides/data-apis/importing-external-files"}]}]},{"group":"Resources","pages":[{"title":"Example code","url":"https://developers.notion.com/page/examples","href":"/guides/resources/examples"},{"title":"Postman workspace","url":"https://www.postman.com/notionhq/notion-s-api-workspace/collection/52041987-03f70d8f-b6e5-4306-805c-f95f7cdf05b9","href":"/guides/resources/notion-s-api-workspace"},{"title":"Historical changelog","href":"/guides/resources/historical-changelog"}]},{"group":"Compliance","pages":[{"title":"Overview","href":"/compliance/overview"},{"group":"Event reference","pages":[{"title":"SIEM events","href":"/compliance/siem-events"},{"title":"Audit log events","href":"/compliance/audit-log-events"}]}]},{"group":"Link previews","pages":[{"title":"Introduction","href":"/guides/link-previews/introduction"}]}]},{"tab":"API Reference","groups":[{"group":"Notion API","pages":[{"title":"Introduction","href":"/reference/intro"},{"title":"Pagination","href":"/reference/pagination"},{"title":"Connection capabilities","href":"/reference/capabilities"},{"group":"Webhooks","pages":[{"title":"Webhooks","sidebarTitle":"Overview","href":"/reference/webhooks"},{"title":"Event types \u0026 delivery","href":"/reference/webhooks-events-delivery"}]},{"title":"Request limits","href":"/reference/request-limits"},{"title":"Workspace block limits","href":"/reference/workspace-block-limits"},{"title":"Status codes","href":"/reference/status-codes"},{"group":"Versioning","pages":[{"title":"Versioning","sidebarTitle":"Overview","href":"/reference/versioning"},{"title":"Changes by version","href":"/reference/changes-by-version"}]}]},{"group":"Objects","pages":[{"group":"Block","pages":[{"title":"Block","sidebarTitle":"Overview","href":"/reference/block"},{"title":"Rich text","href":"/reference/rich-text"}]},{"group":"Page","pages":[{"title":"Page","sidebarTitle":"Overview","href":"/reference/page"},{"group":"Page properties","pages":[{"title":"Page property values","sidebarTitle":"Page values","href":"/reference/page-property-values"},{"title":"Page property items","sidebarTitle":"Property items","href":"/reference/property-item-object"}]}]},{"title":"Database","href":"/reference/database"},{"group":"Data source","pages":[{"title":"Data source","sidebarTitle":"Overview","href":"/reference/data-source"},{"title":"Data source properties","sidebarTitle":"Property schemas","href":"/reference/property-object"}]},{"title":"View","href":"/reference/view"},{"group":"Comment","pages":[{"title":"Comment","sidebarTitle":"Overview","href":"/reference/comment-object"},{"title":"Comment attachment","href":"/reference/comment-attachment"},{"title":"Comment display name","href":"/reference/comment-display-name"}]},{"group":"File","pages":[{"title":"File","sidebarTitle":"Overview","href":"/reference/file-object"},{"title":"File Upload","href":"/reference/file-upload"}]},{"title":"User","href":"/reference/user"},{"title":"Parent","href":"/reference/parent-object"},{"title":"Emoji and icon","href":"/reference/emoji-and-icon"},{"title":"Unfurl attribute (Link Previews)","href":"/reference/unfurl-attribute-object"}]},{"group":"Endpoints","pages":[{"group":"Authentication","pages":[{"title":"Authentication","sidebarTitle":"Overview","href":"/reference/authentication"},{"title":"Create a token","openapi":"post /v1/oauth/token","href":"/reference/create-a-token"},{"openapi":"post /v1/oauth/introspect","title":"Introspect a token","href":"/reference/introspect-token"},{"openapi":"post /v1/oauth/revoke","title":"Revoke a token","href":"/reference/revoke-token"},{"title":"Refresh a token","openapi":"post /v1/oauth/token","href":"/reference/refresh-a-token"}]},{"group":"Async tasks","icon":"/icons/nds/arrowCircleLoopForward.svg","pages":[{"openapi":"openapi.json GET /v1/async_tasks/{task_id}","title":"Retrieve an async task","href":"/reference/retrieve-async-task"}]},{"group":"Blocks","pages":[{"openapi":"patch /v1/blocks/{block_id}/children","title":"Append block children","href":"/reference/patch-block-children"},{"openapi":"get /v1/blocks/{block_id}","title":"Retrieve a block","href":"/reference/retrieve-a-block"},{"openapi":"get /v1/blocks/{block_id}/children","title":"Retrieve block children","href":"/reference/get-block-children"},{"openapi":"patch /v1/blocks/{block_id}","title":"Update a block","href":"/reference/update-a-block"},{"openapi":"delete /v1/blocks/{block_id}","title":"Delete a block","href":"/reference/delete-a-block"},{"title":"Create a meeting note","openapi":"post /v1/blocks/meeting_notes","href":"/reference/create-meeting-note"},{"openapi":"post /v1/blocks/meeting_notes/query","title":"Query meeting notes","href":"/reference/query-meeting-notes"}]},{"group":"Pages","pages":[{"openapi":"post /v1/pages","title":"Create a page","href":"/reference/post-page"},{"openapi":"get /v1/pages/{page_id}","title":"Retrieve a page","href":"/reference/retrieve-a-page"},{"openapi":"get /v1/pages/{page_id}/properties/{property_id}","title":"Retrieve a page property item","href":"/reference/retrieve-a-page-property"},{"openapi":"post /v1/pages/{page_id}/move","title":"Move a page","href":"/reference/move-page"},{"group":"Update page","icon":"/icons/nds/pencil.svg","pages":[{"openapi":"patch /v1/pages/{page_id}","title":"Update page","href":"/reference/patch-page"},{"title":"Trash a page","icon":"trash-can","href":"/reference/trash-page"}]},{"group":"Markdown content","icon":"/icons/nds/poundSign.svg","pages":[{"openapi":"get /v1/pages/{page_id}/markdown","title":"Retrieve a page as markdown","href":"/reference/retrieve-page-markdown"},{"openapi":"patch /v1/pages/{page_id}/markdown","title":"Update a page's content as markdown","href":"/reference/update-page-markdown"}]}]},{"group":"Databases","pages":[{"openapi":"post /v1/databases","title":"Create a database","href":"/reference/create-database"},{"openapi":"patch /v1/databases/{database_id}","title":"Update a database","href":"/reference/update-database"},{"openapi":"get /v1/databases/{database_id}","title":"Retrieve a database","href":"/reference/retrieve-database"}]},{"group":"Data sources","pages":[{"openapi":"post /v1/data_sources","title":"Create a data source","href":"/reference/create-a-data-source"},{"openapi":"get /v1/data_sources/{data_source_id}","title":"Retrieve a data source","href":"/reference/retrieve-a-data-source"},{"title":"List data source templates","openapi":"get /v1/data_sources/{data_source_id}/templates","href":"/reference/list-data-source-templates"},{"group":"Update a data source","icon":"/icons/nds/pencil.svg","pages":[{"openapi":"patch /v1/data_sources/{data_source_id}","title":"Update a data source","href":"/reference/update-a-data-source"},{"title":"Update data source properties","icon":"table-columns","href":"/reference/update-data-source-properties"}]},{"group":"Query a data source","icon":"/icons/nds/clipboard.svg","pages":[{"openapi":"post /v1/data_sources/{data_source_id}/query","title":"Query a data source","href":"/reference/query-a-data-source"},{"title":"Filter data source entries","icon":"filter","href":"/reference/filter-data-source-entries"},{"title":"Sort data source entries","icon":"arrow-down-1-9","href":"/reference/sort-data-source-entries"}]}]},{"group":"Databases (deprecated)","pages":[{"title":"Create a database","openapi":"post /v1/databases","href":"/reference/create-a-database"},{"openapi":"get /v1/databases/{database_id}","title":"Retrieve a database","href":"/reference/retrieve-a-database"},{"openapi":"get /v1/databases","title":null,"href":"/reference/get-databases"},{"group":"Query a database","pages":[{"openapi":"post /v1/databases/{database_id}/query","sidebarTitle":"Overview","title":null,"href":"/reference/post-database-query"},{"title":"Filter database entries","href":"/reference/post-database-query-filter"},{"title":"Sort database entries","href":"/reference/post-database-query-sort"}]},{"group":"Update a database","pages":[{"openapi":"patch /v1/databases/{database_id}","title":"Update a database","href":"/reference/update-a-database"},{"title":"Update database properties (legacy)","sidebarTitle":"Update properties","href":"/reference/update-property-schema-object"}]}]},{"group":"Comments","pages":[{"title":"Create comment","openapi":"post /v1/comments","href":"/reference/create-a-comment"},{"title":"Update comment","openapi":"patch /v1/comments/{comment_id}","href":"/reference/update-a-comment"},{"title":"Delete comment","openapi":"delete /v1/comments/{comment_id}","href":"/reference/delete-a-comment"},{"openapi":"get /v1/comments/{comment_id}","title":"Retrieve a comment","href":"/reference/retrieve-comment"},{"openapi":"get /v1/comments","title":"List comments","href":"/reference/list-comments"}]},{"group":"Views","pages":[{"openapi":"post /v1/views","title":"Create a view","href":"/reference/create-view"},{"openapi":"get /v1/views/{view_id}","title":"Retrieve a view","href":"/reference/retrieve-a-view"},{"openapi":"patch /v1/views/{view_id}","title":"Update a view","href":"/reference/update-a-view"},{"openapi":"delete /v1/views/{view_id}","title":"Delete a view","href":"/reference/delete-view"},{"openapi":"get /v1/views","title":"List views","href":"/reference/list-views"},{"group":"View queries","icon":"/icons/nds/clipboard.svg","pages":[{"openapi":"post /v1/views/{view_id}/queries","title":"Create a view query","href":"/reference/create-view-query"},{"openapi":"get /v1/views/{view_id}/queries/{query_id}","title":"Get view query results","href":"/reference/get-view-query-results"},{"openapi":"delete /v1/views/{view_id}/queries/{query_id}","title":"Delete a view query","href":"/reference/delete-view-query"}]}]},{"group":"File Uploads","pages":[{"openapi":"post /v1/file_uploads","title":"Create a file upload","href":"/reference/create-file"},{"title":"Send a file upload","openapi":"post /v1/file_uploads/{file_upload_id}/send","sidebarTitle":"Send a file upload","href":"/reference/upload-file"},{"title":"Complete a file upload","openapi":"post /v1/file_uploads/{file_upload_id}/complete","href":"/reference/complete-file-upload"},{"openapi":"get /v1/file_uploads/{file_upload_id}","title":"Retrieve a file upload","href":"/reference/retrieve-file-upload"},{"openapi":"get /v1/file_uploads","title":"List file uploads","href":"/reference/list-file-uploads"}]},{"group":"Search","pages":[{"group":"Search by title","icon":"/icons/nds/magnifyingGlass.svg","pages":[{"openapi":"post /v1/search","title":"Search by title","href":"/reference/post-search"}]},{"title":"Search optimizations and limitations","icon":"bolt","href":"/reference/search-optimizations-and-limitations"}]},{"group":"Users","pages":[{"openapi":"get /v1/users","title":"List all users","href":"/reference/get-users"},{"openapi":"get /v1/users/{user_id}","title":"Retrieve a user","href":"/reference/get-user"},{"openapi":"get /v1/users/me","title":"Retrieve your token's bot user","href":"/reference/get-self"}]},{"group":"Custom emojis","pages":[{"openapi":"get /v1/custom_emojis","title":"List custom emojis","href":"/reference/list-custom-emojis"}]},{"group":"Agents","pages":[{"title":"Query agents","openapi":"post /v1/agents/query","href":"/reference/notion-agent-apis/query-agents"},{"title":"Retrieve an agent","openapi":"get /v1/agents/{agent_id}","href":"/reference/notion-agent-apis/retrieve-agent"},{"title":"Retrieve agent insights","openapi":"get /v1/agents/{agent_id}/insights","href":"/reference/notion-agent-apis/retrieve-agent-insights"},{"title":"Update an agent","openapi":"patch /v1/agents/{agent_id}","href":"/reference/notion-agent-apis/update-agent"},{"title":"Update agent status","openapi":"patch /v1/agents/{agent_id}/status","href":"/reference/notion-agent-apis/update-agent-status"},{"title":"Update an agent credit limit","openapi":"patch /v1/agents/{agent_id}/credit_limit","href":"/reference/notion-agent-apis/update-agent-credit-limit"},{"title":"Delete an agent","openapi":"delete /v1/agents/{agent_id}","href":"/reference/notion-agent-apis/delete-agent"},{"title":"Batch manage agent","openapi":"post /v1/agents/batch","href":"/reference/notion-agent-apis/batch-manage-agent"},{"title":"Create or update a session","openapi":"post /v1/sessions","href":"/reference/notion-agent-apis/update-session"},{"title":"Retrieve a session","openapi":"get /v1/sessions/{session_id}","href":"/reference/notion-agent-apis/retrieve-session"},{"title":"Query sessions","openapi":"post /v1/sessions/query","href":"/reference/notion-agent-apis/query-sessions"},{"title":"Query session events","openapi":"post /v1/sessions/{session_id}/events/query","href":"/reference/notion-agent-apis/query-session-events"},{"title":"Cancel a session","openapi":"post /v1/sessions/{session_id}/cancel","href":"/reference/notion-agent-apis/cancel-session"}]},{"group":"Agent Skills","pages":[{"title":"List plugins","openapi":"openapi.json GET /v1/ai/plugins","href":"/reference/agent-skills/list-skills-plugins"},{"title":"Get plugin","openapi":"openapi.json GET /v1/ai/plugins/{id}","href":"/reference/agent-skills/get-plugin-directory"},{"title":"Get skill","openapi":"openapi.json GET /v1/ai/skills/{id}","href":"/reference/agent-skills/get-skill-directory"},{"title":"Upload a skill","openapi":"POST /v1/ai/skills/{id}/upload","href":"/reference/agent-skills/upload-skill"}]}]},{"group":"Webhook events","pages":[{"group":"Pages","pages":[{"title":"Page created","openapi":"openapi.json webhook pageCreated","href":"/reference/webhooks/page-created"},{"title":"Page content updated","openapi":"openapi.json webhook pageContentUpdated","href":"/reference/webhooks/page-content-updated"},{"title":"Page properties updated","openapi":"openapi.json webhook pagePropertiesUpdated","href":"/reference/webhooks/page-properties-updated"},{"title":"Page moved","openapi":"openapi.json webhook pageMoved","href":"/reference/webhooks/page-moved"},{"title":"Page deleted","openapi":"openapi.json webhook pageDeleted","href":"/reference/webhooks/page-deleted"},{"title":"Page undeleted","openapi":"openapi.json webhook pageUndeleted","href":"/reference/webhooks/page-undeleted"},{"title":"Page locked","openapi":"openapi.json webhook pageLocked","href":"/reference/webhooks/page-locked"},{"title":"Page unlocked","openapi":"openapi.json webhook pageUnlocked","href":"/reference/webhooks/page-unlocked"},{"title":"Page transcript deleted","openapi":"openapi.json webhook pageTranscriptionBlockTranscriptDeleted","href":"/reference/webhooks/page-transcription-block-transcript-deleted"}]},{"group":"Databases","pages":[{"title":"Database created","openapi":"openapi.json webhook databaseCreated","href":"/reference/webhooks/database-created"},{"title":"Database content updated","openapi":"openapi.json webhook databaseContentUpdated","href":"/reference/webhooks/database-content-updated"},{"title":"Database schema updated","openapi":"openapi.json webhook databaseSchemaUpdated","href":"/reference/webhooks/database-schema-updated"},{"title":"Database moved","openapi":"openapi.json webhook databaseMoved","href":"/reference/webhooks/database-moved"},{"title":"Database deleted","openapi":"openapi.json webhook databaseDeleted","href":"/reference/webhooks/database-deleted"},{"title":"Database undeleted","openapi":"openapi.json webhook databaseUndeleted","href":"/reference/webhooks/database-undeleted"}]},{"group":"Data sources","pages":[{"title":"Data source created","openapi":"openapi.json webhook dataSourceCreated","href":"/reference/webhooks/data-source-created"},{"title":"Data source content updated","openapi":"openapi.json webhook dataSourceContentUpdated","href":"/reference/webhooks/data-source-content-updated"},{"title":"Data source schema updated","openapi":"openapi.json webhook dataSourceSchemaUpdated","href":"/reference/webhooks/data-source-schema-updated"},{"title":"Data source moved","openapi":"openapi.json webhook dataSourceMoved","href":"/reference/webhooks/data-source-moved"},{"title":"Data source deleted","openapi":"openapi.json webhook dataSourceDeleted","href":"/reference/webhooks/data-source-deleted"},{"title":"Data source undeleted","openapi":"openapi.json webhook dataSourceUndeleted","href":"/reference/webhooks/data-source-undeleted"}]},{"group":"Comments","pages":[{"title":"Comment created","openapi":"openapi.json webhook commentCreated","href":"/reference/webhooks/comment-created"},{"title":"Comment updated","openapi":"openapi.json webhook commentUpdated","href":"/reference/webhooks/comment-updated"},{"title":"Comment deleted","openapi":"openapi.json webhook commentDeleted","href":"/reference/webhooks/comment-deleted"}]},{"group":"File uploads","pages":[{"title":"File upload created","openapi":"openapi.json webhook fileUploadCreated","href":"/reference/webhooks/file-upload-created"},{"title":"File upload completed","openapi":"openapi.json webhook fileUploadCompleted","href":"/reference/webhooks/file-upload-completed"},{"title":"File upload expired","openapi":"openapi.json webhook fileUploadExpired","href":"/reference/webhooks/file-upload-expired"},{"title":"File upload failed","openapi":"openapi.json webhook fileUploadUploadFailed","href":"/reference/webhooks/file-upload-upload-failed"}]},{"group":"Views","pages":[{"title":"View created","openapi":"openapi.json webhook viewCreated","href":"/reference/webhooks/view-created"},{"title":"View updated","openapi":"openapi.json webhook viewUpdated","href":"/reference/webhooks/view-updated"},{"title":"View deleted","openapi":"openapi.json webhook viewDeleted","href":"/reference/webhooks/view-deleted"}]}]}]},{"tab":"CLI Reference","groups":[{"group":"Get started","pages":[{"title":"Notion CLI","sidebarTitle":"Overview","href":"/cli/get-started/overview"},{"title":"Installation","href":"/cli/get-started/installation"},{"title":"Authentication","href":"/cli/get-started/authentication"}]},{"group":"Guides","pages":[{"title":"API requests","href":"/cli/guides/api-requests"},{"title":"Data sources","href":"/cli/guides/data-sources"},{"title":"File uploads","href":"/cli/guides/file-uploads"}]},{"group":"Reference","pages":[{"title":"Command reference","sidebarTitle":"Commands","href":"/cli/reference/commands"}]}]},{"tab":"Workers","groups":[{"group":"Get started","pages":[{"title":"What are Notion Workers?","sidebarTitle":"Overview","href":"/workers/get-started/overview"},{"title":"Quickstart","href":"/workers/get-started/quickstart"}]},{"group":"Guides","pages":[{"title":"Syncs","href":"/workers/guides/syncs"},{"title":"How to write an agent tool","sidebarTitle":"Agent tools","href":"/workers/guides/tools"},{"title":"Webhooks","href":"/workers/guides/webhooks"},{"title":"OAuth","href":"/workers/guides/oauth"},{"title":"How to manage secrets","sidebarTitle":"Secrets","href":"/workers/guides/secrets"},{"title":"Using Notion API from a worker","sidebarTitle":"Notion API","href":"/workers/guides/api-client"},{"title":"Sharing Workers","href":"/workers/guides/sharing-workers"}]},{"group":"Reference","pages":[{"title":"SDK reference","sidebarTitle":"SDK","href":"/workers/reference/sdk"},{"title":"Schema and builders","sidebarTitle":"Schema","href":"/workers/reference/schema"},{"title":"Limits","sidebarTitle":"Limits","href":"/workers/reference/limits"}]}]},{"tab":"Custom blocks","hidden":true,"groups":[{"group":"Get started","pages":[{"title":"Custom blocks","sidebarTitle":"Overview","href":"/custom-blocks/overview"},{"title":"Custom blocks quickstart","sidebarTitle":"Quickstart","href":"/custom-blocks/quickstart"}]},{"group":"Guides","pages":[{"title":"How a block initializes","sidebarTitle":"How a block initializes","href":"/custom-blocks/guides/lifecycle"},{"title":"Place custom blocks with markdown","sidebarTitle":"Markdown placement","href":"/custom-blocks/guides/markdown"},{"title":"Binding a block to Notion data","sidebarTitle":"Binding to Notion data","href":"/custom-blocks/guides/data-sources"},{"title":"Previewing before deploy","sidebarTitle":"Previewing","href":"/custom-blocks/guides/preview"},{"title":"Security","sidebarTitle":"Security","href":"/custom-blocks/guides/security"}]},{"group":"Workers SDK reference","pages":[{"title":"Worker capability","sidebarTitle":"worker.customBlock()","href":"/custom-blocks/workers/capability"}]},{"group":"Custom blocks SDK reference","pages":[{"title":"Initialization","sidebarTitle":"Initialization","href":"/custom-blocks/sdk/initialization"},{"title":"App context","sidebarTitle":"App context","href":"/custom-blocks/sdk/app-context"},{"title":"Appearance and sizing","sidebarTitle":"Appearance and sizing","href":"/custom-blocks/sdk/appearance"},{"title":"Data sources","sidebarTitle":"Data sources","href":"/custom-blocks/sdk/data-sources"},{"title":"Pages","sidebarTitle":"Pages","href":"/custom-blocks/sdk/pages"},{"title":"Users","sidebarTitle":"Users","href":"/custom-blocks/sdk/users"},{"title":"Error handling","sidebarTitle":"Errors","href":"/custom-blocks/sdk/errors"}]},{"group":"CLI reference","pages":[{"title":"ntn CLI commands for custom blocks","sidebarTitle":"ntn workers customblocks","href":"/custom-blocks/cli/commands"}]}]},{"tab":"Admin API","hidden":false,"groups":[{"group":"Admin API","pages":[{"title":"Introduction","href":"/reference/admin/intro"},{"title":"Scopes","href":"/reference/admin/scopes"},{"title":"Versioning","href":"/reference/admin/versioning"}]},{"group":"Endpoints","pages":[{"group":"Legal holds","pages":[{"openapi":"openapi-adminApi.json GET /v1/legal_holds","title":"List legal holds","href":"/reference/admin/list-legal-holds"},{"openapi":"openapi-adminApi.json POST /v1/legal_holds/{legal_hold_id}/users","title":"Add users to a legal hold","href":"/reference/admin/add-legal-hold-users"},{"openapi":"openapi-adminApi.json POST /v1/legal_holds","title":"Create a legal hold","href":"/reference/admin/create-legal-hold"},{"openapi":"openapi-adminApi.json POST /v1/legal_holds/{legal_hold_id}/export","title":"Export a legal hold","href":"/reference/admin/export-legal-hold"},{"openapi":"openapi-adminApi.json GET /v1/legal_holds/{legal_hold_id}","title":"Retrieve a legal hold","href":"/reference/admin/get-legal-hold"},{"openapi":"openapi-adminApi.json GET /v1/legal_holds/{legal_hold_id}/spaces/{space_id}/pages","title":"List pages on a legal hold","href":"/reference/admin/list-legal-hold-pages"},{"openapi":"openapi-adminApi.json GET /v1/legal_holds/{legal_hold_id}/users","title":"List users on a legal hold","href":"/reference/admin/list-legal-hold-users"},{"openapi":"openapi-adminApi.json GET /v1/legal_holds/{legal_hold_id}/workspaces","title":"List workspaces on a legal hold","href":"/reference/admin/list-legal-hold-workspaces"},{"openapi":"openapi-adminApi.json POST /v1/legal_holds/{legal_hold_id}/release","title":"Release a legal hold","href":"/reference/admin/release-legal-hold"},{"openapi":"openapi-adminApi.json DELETE /v1/legal_holds/{legal_hold_id}/users/{user_id}","title":"Remove a user from a legal hold","href":"/reference/admin/remove-legal-hold-user"},{"openapi":"openapi-adminApi.json PATCH /v1/legal_holds/{legal_hold_id}","title":"Update a legal hold","href":"/reference/admin/update-legal-hold"}]},{"group":"Managed users","pages":[{"openapi":"openapi-adminApi.json POST /v1/managed_users/revoke_session","title":"Revoke a managed user's sessions","href":"/reference/admin/revoke-user-session"}]},{"group":"Users","pages":[{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/users","sidebarTitle":"List users","title":"List users","href":"/reference/admin/list-users"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/users/credit_usage","title":"Get credit usage for users in a space","href":"/reference/admin/list-user-credit-usage"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/users/{user_id}/credit_usage","title":"Get credit usage for a user in a space","href":"/reference/admin/list-user-credit-usage-periods"}]},{"group":"Permission groups","pages":[{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/groups","sidebarTitle":"List groups","title":"List groups","href":"/reference/admin/list-permission-groups"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/groups/{group_id}","sidebarTitle":"Retrieve a group","title":"Retrieve a group","href":"/reference/admin/retrieve-permission-group"},{"openapi":"openapi-adminApi.json POST /v1/spaces/{space_id}/groups","sidebarTitle":"Create a group","title":"Create a group","href":"/reference/admin/create-permission-group"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/groups/{group_id}","sidebarTitle":"Update a group","title":"Update a group","href":"/reference/admin/update-permission-group"},{"openapi":"openapi-adminApi.json DELETE /v1/spaces/{space_id}/groups/{group_id}","sidebarTitle":"Delete a group","title":"Delete a group","href":"/reference/admin/delete-permission-group"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/groups/{group_id}/members","sidebarTitle":"List members","title":"List group members","href":"/reference/admin/list-permission-group-members"},{"openapi":"openapi-adminApi.json POST /v1/spaces/{space_id}/groups/{group_id}/members","sidebarTitle":"Add a member","title":"Add a group member","href":"/reference/admin/add-permission-group-member"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/groups/{group_id}/members/users/{user_id}","sidebarTitle":"Update a member","title":"Update a group member","href":"/reference/admin/update-permission-group-member"},{"openapi":"openapi-adminApi.json DELETE /v1/spaces/{space_id}/groups/{group_id}/members/users/{user_id}","sidebarTitle":"Remove a member","title":"Remove a group member","href":"/reference/admin/remove-permission-group-member"}]},{"group":"Agents","pages":[{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/agents","title":"Get agents in a space","href":"/reference/admin/get-workflows-metadata-for-space"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/agents/{agent_id}/credit_usage","title":"Get credit usage for an agent in a space","href":"/reference/admin/get-agent-credit-usage"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/agents/credit_usage","title":"Get credit usage for agents in a space","href":"/reference/admin/get-agents-credit-usage"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/agents/{agent_id}","title":"Update an agent in a space","href":"/reference/admin/update-agent"},{"openapi":"openapi-adminApi.json PUT /v1/spaces/{space_id}/agents/{agent_id}/credit_limit","title":"Update credit limit for an agent in a space","href":"/reference/admin/update-agent-credit-limit"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/agents/{agent_id}/permissions","title":"Get a custom agent's sharing permissions","href":"/reference/admin/get-agent-permissions"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/agents/{agent_id}/permissions","title":"Update a custom agent's sharing permissions","href":"/reference/admin/update-agent-permissions"},{"openapi":"openapi-adminApi.json DELETE /v1/spaces/{space_id}/agents/{agent_id}","title":"Delete an agent in a space","href":"/reference/admin/delete-agent"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/agents/{agent_id}/status","title":"Disable or re-enable an agent in a space","href":"/reference/admin/update-agent-status"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/agents/creation_policy","title":"Update who can create agents in a space","href":"/reference/admin/update-agent-creation-policy"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/credit_limit","hidden":true,"title":"Update the default agent credit limit for a workspace","href":"/reference/admin/update-workspace-credit-limit"}]},{"group":"Credit access policies","pages":[{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/policies/credit_access","title":"List credit access policies","href":"/reference/admin/list-credit-access-policies"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/policies/credit_access/{policy_id}","title":"Get credit access policy","href":"/reference/admin/get-credit-access-policy"},{"openapi":"openapi-adminApi.json POST /v1/spaces/{space_id}/policies/credit_access","title":"Create credit access policy","href":"/reference/admin/create-credit-access-policy"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/policies/credit_access/{policy_id}","title":"Update credit access policy","href":"/reference/admin/update-credit-access-policy"},{"openapi":"openapi-adminApi.json DELETE /v1/spaces/{space_id}/policies/credit_access/{policy_id}","title":"Delete credit access policy","href":"/reference/admin/delete-credit-access-policy"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/policies/credit_access/{policy_id}/assignments","title":"List credit access assignments","href":"/reference/admin/list-credit-access-assignments"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/policies/credit_access/assignments/{assignment_id}","title":"Get credit access assignment","href":"/reference/admin/get-credit-access-assignment"},{"openapi":"openapi-adminApi.json POST /v1/spaces/{space_id}/policies/credit_access/{policy_id}/assignments","title":"Create credit access assignment","href":"/reference/admin/create-credit-access-assignment"},{"openapi":"openapi-adminApi.json PATCH /v1/spaces/{space_id}/policies/credit_access/assignments/{assignment_id}","title":"Update credit access assignment","href":"/reference/admin/update-credit-access-assignment"},{"openapi":"openapi-adminApi.json DELETE /v1/spaces/{space_id}/policies/credit_access/assignments/{assignment_id}","title":"Delete credit access assignment","href":"/reference/admin/delete-credit-access-assignment"}]},{"group":"MCP client connections","pages":[{"openapi":"openapi-adminApi.json GET /v1/mcp_client_connections","sidebarTitle":"List connections","title":"List MCP client connections in an organization","href":"/reference/admin/list-mcp-client-connections"},{"openapi":"openapi-adminApi.json POST /v1/mcp_client_connections/revoke","sidebarTitle":"Revoke a connection","title":"Revoke an MCP client connection","href":"/reference/admin/revoke-mcp-client-connection"},{"openapi":"openapi-adminApi.json PUT /v1/mcp_client_connections/enterprise_managed_access","sidebarTitle":"Manage enterprise access","title":"Deny or restore enterprise-managed MCP client access","href":"/reference/admin/update-mcp-client-connection-enterprise-managed-access"}]},{"group":"Personal access tokens","pages":[{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/personal_access_tokens","sidebarTitle":"List tokens","title":"List personal access tokens in a workspace","href":"/reference/admin/list-personal-access-tokens"},{"openapi":"openapi-adminApi.json DELETE /v1/spaces/{space_id}/personal_access_tokens/{bot_id}","sidebarTitle":"Revoke a token","title":"Revoke a personal access token in a workspace","href":"/reference/admin/revoke-personal-access-token"}]},{"group":"Workspaces","pages":[{"openapi":"openapi-adminApi.json GET /v1/spaces","sidebarTitle":"List workspaces","title":"List workspaces in the organization","href":"/reference/admin/list-spaces"},{"openapi":"openapi-adminApi.json POST /v1/spaces/{space_id}/exports","title":"Enqueue a workspace export","href":"/reference/admin/enqueue-space-export"},{"openapi":"openapi-adminApi.json GET /v1/spaces/{space_id}/exports/{export_job_id}","title":"Get workspace export status","href":"/reference/admin/get-space-export-status"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/page/changelog"}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/page/examples"}]},{"tab":"Prompts","hidden":true,"searchable":true,"groups":[{"group":"Set up Notion for your agent","root":{"title":"Set up Notion for your agent","href":"/prompts/setup"},"pages":[{"title":"Notion MCP setup prompt changelog","sidebarTitle":"Changelog","href":"/prompts/setup/changelog"}]}]},{"tab":"Internal","hidden":true,"groups":[{"group":"Internal Guides","pages":[{"title":"Building a link preview","href":"/guides/internal/link-previews/building-a-link-preview"}]},{"group":"Internal Endpoints","pages":[{"title":"List Agents","openapi":"openapi-undocumented.json GET /v1/agents","href":"/reference/internal/list-agents"},{"title":"Chat with Agent","openapi":"openapi-undocumented.json POST /v1/agents/{agent_id}/chat","href":"/reference/internal/chat-with-agent"},{"title":"Chat with Agent (Streaming)","openapi":"openapi-undocumented.json POST /v1/agents/{agent_id}/chatStream","href":"/reference/internal/chat-with-agent-stream"},{"title":"List threads","openapi":"openapi-undocumented.json GET /v1/agents/{agent_id}/threads","href":"/reference/internal/list-threads"},{"title":"List Thread Messages","openapi":"openapi-undocumented.json GET /v1/threads/{thread_id}/messages","href":"/reference/internal/list-thread-messages"}]}]},{"tab":"Unreleased APIs","hidden":true,"groups":[{"group":"External Agent APIs","pages":[{"group":"External agent stub","tag":"Private Alpha","pages":[{"title":"Start an external agent stub session","openapi":"openapi-undocumented.json POST /v1/external_agent_stub/{agent_id}/sessions","href":"/reference/unreleased/external-agent-apis/start-external-agent-session"},{"title":"Send an external agent stub session message","openapi":"openapi-undocumented.json POST /v1/external_agent_stub/{agent_id}/sessions/{session_id}/messages","href":"/reference/unreleased/external-agent-apis/send-external-agent-session-message"},{"title":"Stream an external agent stub session message","openapi":"openapi-undocumented.json POST /v1/external_agent_stub/{agent_id}/sessions/{session_id}/messages/stream","href":"/reference/unreleased/external-agent-apis/stream-external-agent-session-message"},{"title":"List external agent stub session events","openapi":"openapi-undocumented.json GET /v1/external_agent_stub/{agent_id}/sessions/{session_id}/events","href":"/reference/unreleased/external-agent-apis/list-external-agent-session-events"},{"title":"Create an external agent stub vault","openapi":"openapi-undocumented.json POST /v1/external_agent_stub/{agent_id}/vaults","href":"/reference/unreleased/external-agent-apis/create-external-agent-vault"},{"title":"Update an external agent stub vault","openapi":"openapi-undocumented.json PATCH /v1/external_agent_stub/{agent_id}/vaults/{vault_id}","href":"/reference/unreleased/external-agent-apis/update-external-agent-vault"},{"title":"Delete an external agent stub vault","openapi":"openapi-undocumented.json DELETE /v1/external_agent_stub/{agent_id}/vaults/{vault_id}","href":"/reference/unreleased/external-agent-apis/delete-external-agent-vault"}]}]}]}]},"basePath":"","title":"Link Previews API - Notion Docs","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-CK6QbnxT.js","DynamicMarkdown-BKiHAm_d.js","zoom-image-lightbox-CLQdF-Ar.js","lightbox-handle-r17bVUz3.js"]}
