A valid request URL is required to generate request examples
<string>
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Flow","description":"Customer API documentation, authentication, and release notes from Flow.","colors":{"primary":"#161513","light":"#FDFDFB","dark":"#161513"},"logo":{"light":"https://mintcdn.com/flow-engineering/QmGYaUeO0ddWtnh-/images/flow-brandmark-black.svg?fit=max\u0026auto=format\u0026n=QmGYaUeO0ddWtnh-\u0026q=85\u0026s=0d34a951f38f391deb5fd282cd916cdb","dark":"https://mintcdn.com/flow-engineering/QmGYaUeO0ddWtnh-/images/flow-brandmark-white.svg?fit=max\u0026auto=format\u0026n=QmGYaUeO0ddWtnh-\u0026q=85\u0026s=774a8fa3ceb4bf52f4da3b41b61a57f7","href":"/api"},"favicon":{"light":"https://mintcdn.com/flow-engineering/QmGYaUeO0ddWtnh-/images/flow-logomark-black.svg?fit=max\u0026auto=format\u0026n=QmGYaUeO0ddWtnh-\u0026q=85\u0026s=ac018a1424f55ed7359b2108ce00a8a2","dark":"https://mintcdn.com/flow-engineering/QmGYaUeO0ddWtnh-/images/flow-logomark-white.svg?fit=max\u0026auto=format\u0026n=QmGYaUeO0ddWtnh-\u0026q=85\u0026s=74dd80009400eca6be10a0bb36a90ec4"},"api":{"playground":{"display":"interactive","proxy":false},"examples":{"languages":["curl","python","javascript"],"prefill":false}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FDFDFB","dark":"#161513"}},"search":{"prompt":"Search..."},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"contextual":{"options":["copy","download-spec"],"display":"header"},"thumbnails":{"appearance":"light"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"flow-engineering","hasAudioNarration":false,"actualSubdomain":"flow-engineering","customDomains":["docs.flowengineering.com"],"gitSource":{"type":"github","owner":"theengineeringco","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae57f8867c58c3a14fd7a2d","collectionId":"17730dc8-13eb-48fd-ac9e-9c7ef2a855d4","liveDeploymentHistoryId":"6ae57f8867c58c3a14fd7a2d","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae57f8867c58c3a14fd7a2d","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API","count":205},{"language":"default","tag":"Endpoints","count":191},{"language":"default","tag":"Branches","count":51},{"language":"default","tag":"Release Notes","count":34},{"language":"default","tag":"Entities","count":25},{"language":"default","tag":"Automations","count":19},{"language":"default","tag":"Notifications","count":12},{"language":"default","tag":"Projects","count":12},{"language":"default","tag":"Users","count":12},{"language":"default","tag":"Quickstart","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"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":"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":"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":"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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"a[href*=\"utm_campaign=poweredBy\"]{display:none!important}img[alt=\"Abstract sunset in blue, orange, and purple\"],img[alt=\"Pulsar Orbiting Earth 2 1 2\"]{border-radius:8px}@media (min-width:1024px){#content-area{max-width:55rem}#sidebar{bottom:7.5rem}#sidebar>ul:not(:has(a,button)){display:none}#navbar-transition-maple{inset:auto auto 0 0!important;width:19rem;height:7.5rem;margin-top:0!important;padding:1rem;border-top:1px solid #e5e5e3;border-right:1px solid #e5e5e3;border-bottom:0;background:#fdfdfb!important;backdrop-filter:none}#navbar-transition-maple .nav-tabs{width:100%;flex-direction:column;gap:.25rem}#navbar-transition-maple .nav-tabs-item{min-height:2.5rem;padding:0 .75rem;color:#737373;background:0 0;text-shadow:none}#navbar-transition-maple .nav-tabs-item:hover,#navbar-transition-maple .nav-tabs-item[data-active=true]{color:#161513}#navbar-transition-maple .nav-tabs-item>div.absolute{display:none}.dark #navbar-transition-maple{border-color:#ffffff12;background:#161513!important}.dark #navbar-transition-maple .nav-tabs-item{color:#a3a3a3}.dark #navbar-transition-maple .nav-tabs-item:hover,.dark #navbar-transition-maple .nav-tabs-item[data-active=true]{color:#fdfdfb}#sidebar-content{--sidebar-surface:#fdfdfb;--sidebar-divider:#e5e5e3;--sidebar-header-height:136px;background:var(--sidebar-surface)}.dark #sidebar-content{--sidebar-surface:#161513;--sidebar-divider:#ffffff12}#sidebar-content [data-component-part=scroll-area-viewport]{margin-top:var(--sidebar-header-height);height:calc(100% - var(--sidebar-header-height));padding-top:0;scroll-padding-block:24px}#sidebar-content [data-component-part=scroll-area-content]>:first-child,#sidebar-content [data-component-part=scroll-area-content]>:has(#search-bar-entry){position:absolute;left:28px;right:28px;z-index:20;margin-top:0;background:var(--sidebar-surface)}#sidebar-content [data-component-part=scroll-area-content]>:first-child{top:24px}#sidebar-content [data-component-part=scroll-area-content]>:has(#search-bar-entry){top:76px}#sidebar-content>[data-component-part=scroll-area-scrollbar]{top:var(--sidebar-header-height)!important}#sidebar-content::after,#sidebar-content::before{content:\"\";position:absolute;left:0;right:0;height:24px;z-index:22;pointer-events:none}#sidebar-content::before{top:var(--sidebar-header-height);border-top:1px solid var(--sidebar-divider);background:linear-gradient(to bottom,var(--sidebar-surface),transparent)}#sidebar-content::after{bottom:0;background:linear-gradient(to top,var(--sidebar-surface),transparent)}}"}],"page":{"pagePath":"api/endpoints/delete-users-id","slug":"/api/endpoints/delete-users-id","pageMetadata":{"title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","description":null,"deprecated":null,"version":null,"sidebarTitle":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","openapi":"/openapi/customer-api.json delete /users/{id}","href":"/api/endpoints/delete-users-id","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","description":null,"deprecated":null,"version":null,"sidebarTitle":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","openapi":"/openapi/customer-api.json delete /users/{id}","href":"/api/endpoints/delete-users-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/flow-engineering/38087c76948775a0/api-deployment.js"],"openApiReferenceData":{"operation":{"operationId":"UsersController_removeUser","parameters":["8e539c2f-9d94-4351-b0f1-d81098dfcfca","8601587b-6f7a-4a9b-b20b-20d58f453f4d"],"responses":{"200":"4d20555e-f7a4-429f-931a-25c6e05078dd"},"security":["4b9d0639-8d4e-41ba-8d11-d113159da9f6","cc70d0c2-33e8-4c1b-978e-c53cb7e0e842"],"summary":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","tags":["Users"],"x-flow-mcp-tool":false,"x-mint":{"href":"/api/endpoints/delete-users-id","metadata":{"sidebarTitle":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again."}},"method":"delete","type":"path","servers":["3dd0ab35-e744-475b-9bce-7fef3dbd2d61"],"path":"/users/{id}","baseUrlOptions":["{baseUrl}"],"title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","description":"","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"8e539c2f-9d94-4351-b0f1-d81098dfcfca":{"in":"path","name":"id","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"8601587b-6f7a-4a9b-b20b-20d58f453f4d":{"description":"Workspace identifier","in":"header","name":"customer","required":true,"schema":{"type":"string","isRequired":true,"description":"Workspace identifier","uniqueKey":"","typeLabel":"string"}}},"responses":{"4d20555e-f7a4-429f-931a-25c6e05078dd":{"content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"description":"","exampleType":"generated"}},"security":{"4b9d0639-8d4e-41ba-8d11-d113159da9f6":{"api-key":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"api-key"}},"cc70d0c2-33e8-4c1b-978e-c53cb7e0e842":{"bearer":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"}}},"servers":{"3dd0ab35-e744-475b-9bce-7fef3dbd2d61":{"description":"Flow API","url":"{baseUrl}","variables":{"baseUrl":{"default":"https://backend.branch.flowengineering.com"}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"X-API-Key","type":"apiKey","scopes":[],"schemeName":"api-key"},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api-key","name":"X-API-Key"}],"title":"api-key"},{"schemes":[{"scheme":{"bearerFormat":"JWT","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"openapi/customer-api.json"},"subdomain":"flow-engineering","siteName":"Flow","title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again. - Flow","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-31T05:41:35.655Z","originalFileLocation":"api/endpoints/delete-users-id.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=\"Flow\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_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/flow-engineering/vb2xrNdmc4zJ4fe2/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again. - Flow\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Flow\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.flowengineering.com/api/endpoints/delete-users-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://flow-engineering.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=Remove+a+user+from+the+workspace.+Their+account+and+authored+content+remain%3B+they+lose+access+until+invited+again.\u0026amp;theme=896915a9ead81fd395fd6a01\u0026amp;signature=b358839ca280bf1f9a5e77a267a97a5fae91bb5acf41121e293299bbcf6d215c\">\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=\"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again. - Flow\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://flow-engineering.mintlify.app/_mintlify/api/og/v2?division=Users\u0026amp;title=Remove+a+user+from+the+workspace.+Their+account+and+authored+content+remain%3B+they+lose+access+until+invited+again.\u0026amp;theme=896915a9ead81fd395fd6a01\u0026amp;signature=b358839ca280bf1f9a5e77a267a97a5fae91bb5acf41121e293299bbcf6d215c\">\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/flow-engineering/vb2xrNdmc4zJ4fe2/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Flow\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#161513\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.flowengineering.com/api/endpoints/delete-users-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/endpoints/delete-users-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.flowengineering.com/#organization\",\"name\":\"Flow\",\"url\":\"https://docs.flowengineering.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/flow-engineering/QmGYaUeO0ddWtnh-/images/flow-brandmark-black.svg?fit=max\u0026auto=format\u0026n=QmGYaUeO0ddWtnh-\u0026q=85\u0026s=0d34a951f38f391deb5fd282cd916cdb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.flowengineering.com#website\",\"name\":\"Flow\",\"url\":\"https://docs.flowengineering.com\",\"publisher\":{\"@id\":\"https://docs.flowengineering.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id#webpage\",\"url\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id\",\"name\":\"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.\",\"dateModified\":\"2026-10-31T05:41:35.655Z\",\"isPartOf\":{\"@id\":\"https://docs.flowengineering.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.flowengineering.com/api/endpoints/get-ai-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Users\",\"item\":\"https://docs.flowengineering.com/api/endpoints/get-users\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.\",\"item\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id#apireference\",\"headline\":\"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.\",\"name\":\"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.\",\"url\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.flowengineering.com/api/endpoints/delete-users-id#webpage\"},\"dateModified\":\"2026-10-31T05:41:35.655Z\",\"publisher\":{\"@id\":\"https://docs.flowengineering.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.flowengineering.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Flow\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Flow","nav":{"global":null,"tabs":[{"tab":"API","icon":{"name":"code","library":"lucide"},"groups":[{"group":"Quickstart","pages":[{"title":"API Overview","sidebarTitle":"Overview","href":"/api"},{"title":"Make your first request","href":"/api/quickstart"},{"title":"Authentication","href":"/api/authentication"},{"title":"API conventions","href":"/api/conventions"},{"title":"Explore the API","href":"/api/reference"},{"title":"Read entities","href":"/api/examples/read-entities"},{"title":"Batch writes","href":"/api/examples/batch-writes"},{"title":"Comment threads","href":"/api/examples/comment-threads"}]},{"group":"Automations","pages":[{"title":"Automation overview","sidebarTitle":"Overview","href":"/api/automations/overview"},{"title":"Set up webhook automations","href":"/api/automations/webhooks"},{"title":"Trigger and poll automations","href":"/api/examples/automations"}]},{"group":"Flow MCP","pages":[{"title":"Flow MCP","sidebarTitle":"Overview","href":"/api/mcp/overview"},{"title":"Connect a client","href":"/api/mcp/connect"},{"title":"Use Flow tools","href":"/api/mcp/tools"}]},{"group":"Endpoints","pages":[{"group":"Automations","pages":[{"title":"List the agent chats visible to the caller, newest first","deprecated":null,"version":null,"sidebarTitle":"List the agent chats visible to the caller, newest first","openapi":"/openapi/customer-api.json get /ai/agents","href":"/api/endpoints/get-ai-agents"},{"title":"Start an agent chat on a project (and optionally a branch) with an opening message","deprecated":null,"version":null,"sidebarTitle":"Start an agent chat on a project (and optionally a branch) with an opening message","openapi":"/openapi/customer-api.json post /ai/agents","href":"/api/endpoints/post-ai-agents"},{"title":"Read an agent chat: its transcript, status and outcome","deprecated":null,"version":null,"sidebarTitle":"Read an agent chat: its transcript, status and outcome","openapi":"/openapi/customer-api.json get /ai/agents/{id}","href":"/api/endpoints/get-ai-agents-id"},{"title":"Send a follow-up message to an agent chat","deprecated":null,"version":null,"sidebarTitle":"Send a follow-up message to an agent chat","openapi":"/openapi/customer-api.json post /ai/agents/{id}/messages","href":"/api/endpoints/post-ai-agents-id-messages"},{"title":"Trigger automation from any source","deprecated":null,"version":null,"sidebarTitle":"Trigger automation from any source","openapi":"/openapi/customer-api.json post /ai/trigger","href":"/api/endpoints/post-ai-trigger"},{"title":"Trigger branch-review automations when the review page opens","deprecated":null,"version":null,"sidebarTitle":"Trigger branch-review automations when the review page opens","openapi":"/openapi/customer-api.json post /ai/trigger/branch","href":"/api/endpoints/post-ai-trigger-branch"},{"title":"Get branch automation checks","deprecated":null,"version":null,"sidebarTitle":"Get branch automation checks","openapi":"/openapi/customer-api.json get /ai/trigger/branch/checks","href":"/api/endpoints/get-ai-trigger-branch-checks"},{"title":"Re-run branch-review automations (a single one, all, or only the checks not passing) on demand","deprecated":null,"version":null,"sidebarTitle":"Re-run branch-review automations (a single one, all, or only the checks not passing) on demand","openapi":"/openapi/customer-api.json post /ai/trigger/branch/rerun","href":"/api/endpoints/post-ai-trigger-branch-rerun"},{"title":"Get branch automation status","deprecated":null,"version":null,"sidebarTitle":"Get branch automation status","openapi":"/openapi/customer-api.json get /ai/trigger/branch/status","href":"/api/endpoints/get-ai-trigger-branch-status"},{"title":"Trigger automation from GitHub","deprecated":null,"version":null,"sidebarTitle":"Trigger automation from GitHub","openapi":"/openapi/customer-api.json post /ai/trigger/github","href":"/api/endpoints/post-ai-trigger-github"},{"title":"Poll automation runs by agent id — status, and the integration response once finished","deprecated":null,"version":null,"sidebarTitle":"Poll automation runs by agent id — status, and the integration response once finished","openapi":"/openapi/customer-api.json get /ai/trigger/runs","href":"/api/endpoints/get-ai-trigger-runs"},{"title":"Get a project's automations","deprecated":null,"version":null,"sidebarTitle":"Get a project's automations","openapi":"/openapi/customer-api.json get /project/{projectId}/automations","href":"/api/endpoints/get-project-projectid-automations"},{"title":"Create an automation","deprecated":null,"version":null,"sidebarTitle":"Create an automation","openapi":"/openapi/customer-api.json post /project/{projectId}/automations","href":"/api/endpoints/post-project-projectid-automations"},{"title":"Get an automation","deprecated":null,"version":null,"sidebarTitle":"Get an automation","openapi":"/openapi/customer-api.json get /project/{projectId}/automations/{automationId}","href":"/api/endpoints/get-project-projectid-automations-automationid"},{"title":"Delete an automation","deprecated":null,"version":null,"sidebarTitle":"Delete an automation","openapi":"/openapi/customer-api.json delete /project/{projectId}/automations/{automationId}","href":"/api/endpoints/delete-project-projectid-automations-automationid"},{"title":"Update an automation","deprecated":null,"version":null,"sidebarTitle":"Update an automation","openapi":"/openapi/customer-api.json patch /project/{projectId}/automations/{automationId}","href":"/api/endpoints/patch-project-projectid-automations-automationid"}]},{"group":"Audit","pages":[{"title":"List workspace-wide admin audit log entries","deprecated":null,"version":null,"sidebarTitle":"List workspace-wide admin audit log entries","openapi":"/openapi/customer-api.json get /audit-log","href":"/api/endpoints/get-audit-log"},{"title":"List admin audit log entries for a project","deprecated":null,"version":null,"sidebarTitle":"List admin audit log entries for a project","openapi":"/openapi/customer-api.json get /project/{projectId}/audit-log","href":"/api/endpoints/get-project-projectid-audit-log"}]},{"group":"Convert","pages":[{"title":"Convert a diagram XML document to a tldraw snapshot","deprecated":null,"version":null,"sidebarTitle":"Convert a diagram XML document to a tldraw snapshot","openapi":"/openapi/customer-api.json post /convert/drawio-to-tldraw","href":"/api/endpoints/post-convert-drawio-to-tldraw"},{"title":"Convert markdown to rich text JSON","deprecated":null,"version":null,"sidebarTitle":"Convert markdown to rich text JSON","openapi":"/openapi/customer-api.json post /convert/markdown-to-rich-text","href":"/api/endpoints/post-convert-markdown-to-rich-text"},{"title":"Convert multiple markdown strings to rich text JSON","deprecated":null,"version":null,"sidebarTitle":"Convert multiple markdown strings to rich text JSON","openapi":"/openapi/customer-api.json post /convert/markdown-to-rich-text/batch","href":"/api/endpoints/post-convert-markdown-to-rich-text-batch"},{"title":"Convert rich text JSON to markdown","deprecated":null,"version":null,"sidebarTitle":"Convert rich text JSON to markdown","openapi":"/openapi/customer-api.json post /convert/rich-text-to-markdown","href":"/api/endpoints/post-convert-rich-text-to-markdown"},{"title":"Convert a tldraw snapshot to hierarchical XML","deprecated":null,"version":null,"sidebarTitle":"Convert a tldraw snapshot to hierarchical XML","openapi":"/openapi/customer-api.json post /convert/tldraw-to-xml","href":"/api/endpoints/post-convert-tldraw-to-xml"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"sidebarTitle":"List notifications","openapi":"/openapi/customer-api.json get /notifications/feed","href":"/api/endpoints/get-notifications-feed"},{"title":"Mark all notifications read","deprecated":null,"version":null,"sidebarTitle":"Mark all notifications read","openapi":"/openapi/customer-api.json post /notifications/feed/read-all","href":"/api/endpoints/post-notifications-feed-read-all"},{"title":"Count unread notifications","deprecated":null,"version":null,"sidebarTitle":"Count unread notifications","openapi":"/openapi/customer-api.json get /notifications/feed/unread-count","href":"/api/endpoints/get-notifications-feed-unread-count"},{"title":"Mark a notification read","deprecated":null,"version":null,"sidebarTitle":"Mark a notification read","openapi":"/openapi/customer-api.json patch /notifications/feed/{id}/read","href":"/api/endpoints/patch-notifications-feed-id-read"},{"title":"GET /notifications/feed/{id}/thread","deprecated":null,"version":null,"sidebarTitle":"GET /notifications/feed/{id}/thread","openapi":"/openapi/customer-api.json get /notifications/feed/{id}/thread","href":"/api/endpoints/get-notifications-feed-id-thread"},{"title":"Mark a notification unread","deprecated":null,"version":null,"sidebarTitle":"Mark a notification unread","openapi":"/openapi/customer-api.json patch /notifications/feed/{id}/unread","href":"/api/endpoints/patch-notifications-feed-id-unread"},{"title":"Get notification preferences","deprecated":null,"version":null,"sidebarTitle":"Get notification preferences","openapi":"/openapi/customer-api.json get /notifications/preferences","href":"/api/endpoints/get-notifications-preferences"},{"title":"Update notification preferences","deprecated":null,"version":null,"sidebarTitle":"Update notification preferences","openapi":"/openapi/customer-api.json patch /notifications/preferences","href":"/api/endpoints/patch-notifications-preferences"},{"title":"List subscribers","deprecated":null,"version":null,"sidebarTitle":"List subscribers","openapi":"/openapi/customer-api.json get /notifications/subscribers","href":"/api/endpoints/get-notifications-subscribers"},{"title":"Create a subscription","deprecated":null,"version":null,"sidebarTitle":"Create a subscription","openapi":"/openapi/customer-api.json post /notifications/subscriptions","href":"/api/endpoints/post-notifications-subscriptions"},{"title":"Remove a subscription","deprecated":null,"version":null,"sidebarTitle":"Remove a subscription","openapi":"/openapi/customer-api.json delete /notifications/subscriptions","href":"/api/endpoints/delete-notifications-subscriptions"},{"title":"Get subscription status","deprecated":null,"version":null,"sidebarTitle":"Get subscription status","openapi":"/openapi/customer-api.json get /notifications/subscriptions/status","href":"/api/endpoints/get-notifications-subscriptions-status"}]},{"group":"Projects","pages":[{"title":"List all projects for the current workspace","deprecated":null,"version":null,"sidebarTitle":"List all projects for the current workspace","openapi":"/openapi/customer-api.json get /project","href":"/api/endpoints/get-project"},{"title":"Create a new project","deprecated":null,"version":null,"sidebarTitle":"Create a new project","openapi":"/openapi/customer-api.json post /project","href":"/api/endpoints/post-project"},{"title":"Get a project by slug","deprecated":null,"version":null,"sidebarTitle":"Get a project by slug","openapi":"/openapi/customer-api.json get /project/slug/{slug}","href":"/api/endpoints/get-project-slug-slug"},{"title":"Get a project by ID","deprecated":null,"version":null,"sidebarTitle":"Get a project by ID","openapi":"/openapi/customer-api.json get /project/{projectId}","href":"/api/endpoints/get-project-projectid"},{"title":"Soft-delete a project","deprecated":null,"version":null,"sidebarTitle":"Soft-delete a project","openapi":"/openapi/customer-api.json delete /project/{projectId}","href":"/api/endpoints/delete-project-projectid"},{"title":"Update a project — slug is regenerated when name changes","deprecated":null,"version":null,"sidebarTitle":"Update a project — slug is regenerated when name changes","openapi":"/openapi/customer-api.json patch /project/{projectId}","href":"/api/endpoints/patch-project-projectid"},{"title":"Get the project's or the requester's Flow.md","deprecated":null,"version":null,"sidebarTitle":"Get the project's or the requester's Flow.md","openapi":"/openapi/customer-api.json get /project/{projectId}/flow-md","href":"/api/endpoints/get-project-projectid-flow-md"},{"title":"Replace the project's or the requester's Flow.md","deprecated":null,"version":null,"sidebarTitle":"Replace the project's or the requester's Flow.md","openapi":"/openapi/customer-api.json put /project/{projectId}/flow-md","href":"/api/endpoints/put-project-projectid-flow-md"},{"title":"Get the project's sidebar notifications toggle","deprecated":null,"version":null,"sidebarTitle":"Get the project's sidebar notifications toggle","openapi":"/openapi/customer-api.json get /project/{projectId}/sidebar-notifications-enabled","href":"/api/endpoints/get-project-projectid-sidebar-notifications-enabled"},{"title":"Get the workspace's updated variant-view toggle","deprecated":null,"version":null,"sidebarTitle":"Get the workspace's updated variant-view toggle","openapi":"/openapi/customer-api.json get /project/{projectId}/updated-variant-view-enabled","href":"/api/endpoints/get-project-projectid-updated-variant-view-enabled"},{"title":"Always true (false for external recipients)","deprecated":true,"version":null,"sidebarTitle":"Always true (false for external recipients)","openapi":"/openapi/customer-api.json get /project/{projectId}/variants-enabled","href":"/api/endpoints/get-project-projectid-variants-enabled"},{"title":"No-op: variants can no longer be turned off","deprecated":true,"version":null,"sidebarTitle":"No-op: variants can no longer be turned off","openapi":"/openapi/customer-api.json put /project/{projectId}/variants-enabled","href":"/api/endpoints/put-project-projectid-variants-enabled"}]},{"group":"Persistent agents","pages":[{"title":"List the persistent agents of a project","deprecated":null,"version":null,"sidebarTitle":"List the persistent agents of a project","openapi":"/openapi/customer-api.json get /project/{projectId}/agents","href":"/api/endpoints/get-project-projectid-agents"},{"title":"Create a persistent agent","deprecated":null,"version":null,"sidebarTitle":"Create a persistent agent","openapi":"/openapi/customer-api.json post /project/{projectId}/agents","href":"/api/endpoints/post-project-projectid-agents"},{"title":"List the hand launches the agents of a project offer","deprecated":null,"version":null,"sidebarTitle":"List the hand launches the agents of a project offer","openapi":"/openapi/customer-api.json get /project/{projectId}/agents/hand-triggers","href":"/api/endpoints/get-project-projectid-agents-hand-triggers"},{"title":"Get a persistent agent","deprecated":null,"version":null,"sidebarTitle":"Get a persistent agent","openapi":"/openapi/customer-api.json get /project/{projectId}/agents/{agentId}","href":"/api/endpoints/get-project-projectid-agents-agentid"},{"title":"Archive a persistent agent","deprecated":null,"version":null,"sidebarTitle":"Archive a persistent agent","openapi":"/openapi/customer-api.json delete /project/{projectId}/agents/{agentId}","href":"/api/endpoints/delete-project-projectid-agents-agentid"},{"title":"Update a persistent agent","deprecated":null,"version":null,"sidebarTitle":"Update a persistent agent","openapi":"/openapi/customer-api.json patch /project/{projectId}/agents/{agentId}","href":"/api/endpoints/patch-project-projectid-agents-agentid"},{"title":"Fire one of an agent's manual triggers by hand","deprecated":null,"version":null,"sidebarTitle":"Fire one of an agent's manual triggers by hand","openapi":"/openapi/customer-api.json post /project/{projectId}/agents/{agentId}/triggers/{triggerId}/fire","href":"/api/endpoints/post-project-projectid-agents-agentid-triggers-triggerid-fire"}]},{"group":"Branches","pages":[{"title":"List all branches","deprecated":null,"version":null,"sidebarTitle":"List all branches","openapi":"/openapi/customer-api.json get /project/{projectId}/branch","href":"/api/endpoints/get-project-projectid-branch"},{"title":"Create a new branch","deprecated":null,"version":null,"sidebarTitle":"Create a new branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch","href":"/api/endpoints/post-project-projectid-branch"},{"title":"List deleted branches","deprecated":null,"version":null,"sidebarTitle":"List deleted branches","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/archived","href":"/api/endpoints/get-project-projectid-branch-archived"},{"title":"List branches awaiting the current user’s review","deprecated":null,"version":null,"sidebarTitle":"List branches awaiting the current user’s review","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/awaiting-review","href":"/api/endpoints/get-project-projectid-branch-awaiting-review"},{"title":"Revert a baseline by proposing an inverse-diff branch","deprecated":null,"version":null,"sidebarTitle":"Revert a baseline by proposing an inverse-diff branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/baseline/{baselineId}/revert","href":"/api/endpoints/post-project-projectid-branch-baseline-baselineid-revert"},{"title":"List draft, open, and merged change requests","deprecated":null,"version":null,"sidebarTitle":"List draft, open, and merged change requests","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/change-requests","href":"/api/endpoints/get-project-projectid-branch-change-requests"},{"title":"Get one draft, open, or merged change request","deprecated":null,"version":null,"sidebarTitle":"Get one draft, open, or merged change request","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/change-requests/{id}","href":"/api/endpoints/get-project-projectid-branch-change-requests-id"},{"title":"List a branch’s direct child branches, paginated","deprecated":null,"version":null,"sidebarTitle":"List a branch’s direct child branches, paginated","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/children","href":"/api/endpoints/get-project-projectid-branch-children"},{"title":"Reserve a number and suggest a branch name","deprecated":null,"version":null,"sidebarTitle":"Reserve a number and suggest a branch name","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/name-suggestion","href":"/api/endpoints/post-project-projectid-branch-name-suggestion"},{"title":"List review requests (open, merged, and closed branches)","deprecated":null,"version":null,"sidebarTitle":"List review requests (open, merged, and closed branches)","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/review-requests","href":"/api/endpoints/get-project-projectid-branch-review-requests"},{"title":"Filter and sort branches server-side, paginated","deprecated":null,"version":null,"sidebarTitle":"Filter and sort branches server-side, paginated","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/search","href":"/api/endpoints/get-project-projectid-branch-search"},{"title":"List the project’s distinct branch tags","deprecated":null,"version":null,"sidebarTitle":"List the project’s distinct branch tags","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/tags","href":"/api/endpoints/get-project-projectid-branch-tags"},{"title":"Remove a branch tag from every branch in a project","deprecated":null,"version":null,"sidebarTitle":"Remove a branch tag from every branch in a project","openapi":"/openapi/customer-api.json delete /project/{projectId}/branch/tags","href":"/api/endpoints/delete-project-projectid-branch-tags"},{"title":"Rename a branch tag across the project","deprecated":null,"version":null,"sidebarTitle":"Rename a branch tag across the project","openapi":"/openapi/customer-api.json patch /project/{projectId}/branch/tags","href":"/api/endpoints/patch-project-projectid-branch-tags"},{"title":"Plan an entity-level extraction into a new sibling branch","deprecated":null,"version":null,"sidebarTitle":"Plan an entity-level extraction into a new sibling branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{branchId}/extraction-plans","href":"/api/endpoints/post-project-projectid-branch-branchid-extraction-plans"},{"title":"Read a frozen extraction plan and current status","deprecated":null,"version":null,"sidebarTitle":"Read a frozen extraction plan and current status","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{branchId}/extraction-plans/{planId}","href":"/api/endpoints/get-project-projectid-branch-branchid-extraction-plans-planid"},{"title":"Execute a frozen entity extraction plan","deprecated":null,"version":null,"sidebarTitle":"Execute a frozen entity extraction plan","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{branchId}/extractions","href":"/api/endpoints/post-project-projectid-branch-branchid-extractions"},{"title":"Read extraction audit and undo eligibility","deprecated":null,"version":null,"sidebarTitle":"Read extraction audit and undo eligibility","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{branchId}/extractions/{extractionId}","href":"/api/endpoints/get-project-projectid-branch-branchid-extractions-extractionid"},{"title":"Undo an exact, still-isolated extraction","deprecated":null,"version":null,"sidebarTitle":"Undo an exact, still-isolated extraction","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{branchId}/extractions/{extractionId}/undo","href":"/api/endpoints/post-project-projectid-branch-branchid-extractions-extractionid-undo"},{"title":"List a branch’s ancestors, root-first","deprecated":null,"version":null,"sidebarTitle":"List a branch’s ancestors, root-first","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/ancestors","href":"/api/endpoints/get-project-projectid-branch-id-ancestors"},{"title":"Merge a branch automatically once it is ready","deprecated":null,"version":null,"sidebarTitle":"Merge a branch automatically once it is ready","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/auto-merge","href":"/api/endpoints/post-project-projectid-branch-id-auto-merge"},{"title":"Changed entities on a branch awaiting the current user's review","deprecated":null,"version":null,"sidebarTitle":"Changed entities on a branch awaiting the current user's review","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/awaiting-my-review-entities","href":"/api/endpoints/get-project-projectid-branch-id-awaiting-my-review-entities"},{"title":"Set the change request's title","deprecated":null,"version":null,"sidebarTitle":"Set the change request's title","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/change-request-title","href":"/api/endpoints/post-project-projectid-branch-id-change-request-title"},{"title":"List changed entities on a branch","deprecated":null,"version":null,"sidebarTitle":"List changed entities on a branch","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/changed-entity-ids","href":"/api/endpoints/get-project-projectid-branch-id-changed-entity-ids"},{"title":"Delete a branch","deprecated":null,"version":null,"sidebarTitle":"Delete a branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/delete","href":"/api/endpoints/post-project-projectid-branch-id-delete"},{"title":"Entities deleted on this branch (its tombstones), newest first","deprecated":null,"version":null,"sidebarTitle":"Entities deleted on this branch (its tombstones), newest first","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/deleted-entities","href":"/api/endpoints/get-project-projectid-branch-id-deleted-entities"},{"title":"Set the branch's rich-text description","deprecated":null,"version":null,"sidebarTitle":"Set the branch's rich-text description","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/description","href":"/api/endpoints/post-project-projectid-branch-id-description"},{"title":"Merge a branch into its parent","deprecated":null,"version":null,"sidebarTitle":"Merge a branch into its parent","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/merge","href":"/api/endpoints/post-project-projectid-branch-id-merge"},{"title":"Get the current background merge job for a branch","deprecated":null,"version":null,"sidebarTitle":"Get the current background merge job for a branch","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/merge-status","href":"/api/endpoints/get-project-projectid-branch-id-merge-status"},{"title":"Protect a branch","deprecated":null,"version":null,"sidebarTitle":"Protect a branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/protect","href":"/api/endpoints/post-project-projectid-branch-id-protect"},{"title":"Rebase a branch onto a different parent branch (as a new branch)","deprecated":null,"version":null,"sidebarTitle":"Rebase a branch onto a different parent branch (as a new branch)","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/rebase-onto","href":"/api/endpoints/post-project-projectid-branch-id-rebase-onto"},{"title":"Revert a merged change request into a new draft","deprecated":null,"version":null,"sidebarTitle":"Revert a merged change request into a new draft","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/reopen-as-draft","href":"/api/endpoints/post-project-projectid-branch-id-reopen-as-draft"},{"title":"Add a required reviewer group (admin, owner, or existing required reviewer)","deprecated":null,"version":null,"sidebarTitle":"Add a required reviewer group (admin, owner, or existing required reviewer)","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/required-reviewer-groups","href":"/api/endpoints/post-project-projectid-branch-id-required-reviewer-groups"},{"title":"Remove a required reviewer group (owner or existing required reviewer)","deprecated":null,"version":null,"sidebarTitle":"Remove a required reviewer group (owner or existing required reviewer)","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/required-reviewer-groups/{groupId}/remove","href":"/api/endpoints/post-project-projectid-branch-id-required-reviewer-groups-groupid-remove"},{"title":"Add a required reviewer (admin, owner, or existing required reviewer)","deprecated":null,"version":null,"sidebarTitle":"Add a required reviewer (admin, owner, or existing required reviewer)","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/required-reviewers","href":"/api/endpoints/post-project-projectid-branch-id-required-reviewers"},{"title":"Remove a required reviewer (owner or existing required reviewer)","deprecated":null,"version":null,"sidebarTitle":"Remove a required reviewer (owner or existing required reviewer)","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/required-reviewers/{userId}/remove","href":"/api/endpoints/post-project-projectid-branch-id-required-reviewers-userid-remove"},{"title":"Restore a deleted branch","deprecated":null,"version":null,"sidebarTitle":"Restore a deleted branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/restore","href":"/api/endpoints/post-project-projectid-branch-id-restore"},{"title":"Preview a branch restore","deprecated":null,"version":null,"sidebarTitle":"Preview a branch restore","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/restore-preview","href":"/api/endpoints/get-project-projectid-branch-id-restore-preview"},{"title":"Revert one item to an earlier point in its history","deprecated":null,"version":null,"sidebarTitle":"Revert one item to an earlier point in its history","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/revert-entity-to-point","href":"/api/endpoints/post-project-projectid-branch-id-revert-entity-to-point"},{"title":"Remove a reviewer group from this branch review","deprecated":null,"version":null,"sidebarTitle":"Remove a reviewer group from this branch review","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/reviewer-groups/{groupId}/remove","href":"/api/endpoints/post-project-projectid-branch-id-reviewer-groups-groupid-remove"},{"title":"Remove a reviewer from this branch review","deprecated":null,"version":null,"sidebarTitle":"Remove a reviewer from this branch review","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/reviewers/{userId}/remove","href":"/api/endpoints/post-project-projectid-branch-id-reviewers-userid-remove"},{"title":"Assign or clear the user groups allowed to edit this branch","deprecated":null,"version":null,"sidebarTitle":"Assign or clear the user groups allowed to edit this branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/set-editor-groups","href":"/api/endpoints/post-project-projectid-branch-id-set-editor-groups"},{"title":"Allow or stop edits on a variant landing on it directly instead of opening a change request","deprecated":null,"version":null,"sidebarTitle":"Allow or stop edits on a variant landing on it directly instead of opening a change request","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/set-live-edits-allowed","href":"/api/endpoints/post-project-projectid-branch-id-set-live-edits-allowed"},{"title":"Assign the owner of a branch","deprecated":null,"version":null,"sidebarTitle":"Assign the owner of a branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/set-owner","href":"/api/endpoints/post-project-projectid-branch-id-set-owner"},{"title":"Toggle the branch’s ready-for-review signal","deprecated":null,"version":null,"sidebarTitle":"Toggle the branch’s ready-for-review signal","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/set-ready-for-review","href":"/api/endpoints/post-project-projectid-branch-id-set-ready-for-review"},{"title":"Set branch review requirements","deprecated":null,"version":null,"sidebarTitle":"Set branch review requirements","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/set-require-review","href":"/api/endpoints/post-project-projectid-branch-id-set-require-review"},{"title":"Submit or update the current user's review","deprecated":null,"version":null,"sidebarTitle":"Submit or update the current user's review","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/set-review","href":"/api/endpoints/post-project-projectid-branch-id-set-review"},{"title":"Evaluate entity stage gates for a branch merge","deprecated":null,"version":null,"sidebarTitle":"Evaluate entity stage gates for a branch merge","openapi":"/openapi/customer-api.json get /project/{projectId}/branch/{id}/stage-gate-status","href":"/api/endpoints/get-project-projectid-branch-id-stage-gate-status"},{"title":"Add one tag to a branch","deprecated":null,"version":null,"sidebarTitle":"Add one tag to a branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/tags","href":"/api/endpoints/post-project-projectid-branch-id-tags"},{"title":"Remove one tag from a branch","deprecated":null,"version":null,"sidebarTitle":"Remove one tag from a branch","openapi":"/openapi/customer-api.json delete /project/{projectId}/branch/{id}/tags","href":"/api/endpoints/delete-project-projectid-branch-id-tags"},{"title":"Unprotect a branch","deprecated":null,"version":null,"sidebarTitle":"Unprotect a branch","openapi":"/openapi/customer-api.json post /project/{projectId}/branch/{id}/unprotect","href":"/api/endpoints/post-project-projectid-branch-id-unprotect"}]},{"group":"Data Model","pages":[{"title":"List all categories","deprecated":null,"version":null,"sidebarTitle":"List all categories","openapi":"/openapi/customer-api.json get /project/{projectId}/data-model","href":"/api/endpoints/get-project-projectid-data-model"},{"title":"Create a category","deprecated":null,"version":null,"sidebarTitle":"Create a category","openapi":"/openapi/customer-api.json post /project/{projectId}/data-model","href":"/api/endpoints/post-project-projectid-data-model"},{"title":"Get a category by ID","deprecated":null,"version":null,"sidebarTitle":"Get a category by ID","openapi":"/openapi/customer-api.json get /project/{projectId}/data-model/{id}","href":"/api/endpoints/get-project-projectid-data-model-id"},{"title":"Update a category","deprecated":null,"version":null,"sidebarTitle":"Update a category","openapi":"/openapi/customer-api.json put /project/{projectId}/data-model/{id}","href":"/api/endpoints/put-project-projectid-data-model-id"},{"title":"Delete a category","deprecated":null,"version":null,"sidebarTitle":"Delete a category","openapi":"/openapi/customer-api.json delete /project/{projectId}/data-model/{id}","href":"/api/endpoints/delete-project-projectid-data-model-id"},{"title":"Add tag options to a category field","deprecated":null,"version":null,"sidebarTitle":"Add tag options to a category field","openapi":"/openapi/customer-api.json post /project/{projectId}/data-model/{id}/fields/{fieldKey}/tag-options","href":"/api/endpoints/post-project-projectid-data-model-id-fields-fieldkey-tag-options"}]},{"group":"Diagrams","pages":[{"title":"Create or update a diagram","deprecated":null,"version":null,"sidebarTitle":"Create or update a diagram","openapi":"/openapi/customer-api.json post /project/{projectId}/diagrams","href":"/api/endpoints/post-project-projectid-diagrams"},{"title":"Read shared architecture layout, independent of change requests","deprecated":null,"version":null,"sidebarTitle":"Read shared architecture layout, independent of change requests","openapi":"/openapi/customer-api.json get /project/{projectId}/diagrams/architecture-layout/{scope}","href":"/api/endpoints/get-project-projectid-diagrams-architecture-layout-scope"},{"title":"Save shared architecture layout without model diffs","deprecated":null,"version":null,"sidebarTitle":"Save shared architecture layout without model diffs","openapi":"/openapi/customer-api.json put /project/{projectId}/diagrams/architecture-layout/{scope}","href":"/api/endpoints/put-project-projectid-diagrams-architecture-layout-scope"}]},{"group":"Entities","pages":[{"title":"List all entities with pagination","deprecated":null,"version":null,"sidebarTitle":"List all entities with pagination","openapi":"/openapi/customer-api.json get /project/{projectId}/entities","href":"/api/endpoints/get-project-projectid-entities"},{"title":"Create an entity","deprecated":null,"version":null,"sidebarTitle":"Create an entity","openapi":"/openapi/customer-api.json post /project/{projectId}/entities","href":"/api/endpoints/post-project-projectid-entities"},{"title":"Create multiple entities in one transaction","deprecated":null,"version":null,"sidebarTitle":"Create multiple entities in one transaction","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/batch","href":"/api/endpoints/post-project-projectid-entities-batch"},{"title":"Delete multiple entities in one transaction","deprecated":null,"version":null,"sidebarTitle":"Delete multiple entities in one transaction","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/delete/batch","href":"/api/endpoints/post-project-projectid-entities-delete-batch"},{"title":"Filter live entities across a project","deprecated":null,"version":null,"sidebarTitle":"Filter live entities across a project","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/filter/query","href":"/api/endpoints/post-project-projectid-entities-filter-query"},{"title":"Get a paginated change-history page for multiple entities","deprecated":null,"version":null,"sidebarTitle":"Get a paginated change-history page for multiple entities","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/history","href":"/api/endpoints/post-project-projectid-entities-history"},{"title":"Add multiple links in one transaction","deprecated":null,"version":null,"sidebarTitle":"Add multiple links in one transaction","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/links/batch","href":"/api/endpoints/post-project-projectid-entities-links-batch"},{"title":"Remove multiple links in one transaction","deprecated":null,"version":null,"sidebarTitle":"Remove multiple links in one transaction","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/links/remove/batch","href":"/api/endpoints/post-project-projectid-entities-links-remove-batch"},{"title":"Reorder downstream links of many parents in one request","deprecated":null,"version":null,"sidebarTitle":"Reorder downstream links of many parents in one request","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/reorder/batch","href":"/api/endpoints/post-project-projectid-entities-reorder-batch"},{"title":"Restore multiple deleted entities in one transaction","deprecated":null,"version":null,"sidebarTitle":"Restore multiple deleted entities in one transaction","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/restore/batch","href":"/api/endpoints/post-project-projectid-entities-restore-batch"},{"title":"Search live entities in a project and branch","deprecated":null,"version":null,"sidebarTitle":"Search live entities in a project and branch","openapi":"/openapi/customer-api.json get /project/{projectId}/entities/search","href":"/api/endpoints/get-project-projectid-entities-search"},{"title":"Bulk upsert entities by ID","deprecated":null,"version":null,"sidebarTitle":"Bulk upsert entities by ID","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/upsert","href":"/api/endpoints/post-project-projectid-entities-upsert"},{"title":"Set multiple values in one transaction","deprecated":null,"version":null,"sidebarTitle":"Set multiple values in one transaction","openapi":"/openapi/customer-api.json put /project/{projectId}/entities/values/batch","href":"/api/endpoints/put-project-projectid-entities-values-batch"},{"title":"Delete an entity","deprecated":null,"version":null,"sidebarTitle":"Delete an entity","openapi":"/openapi/customer-api.json delete /project/{projectId}/entities/{entityId}","href":"/api/endpoints/delete-project-projectid-entities-entityid"},{"title":"List an entity's cross-linked peers","deprecated":null,"version":null,"sidebarTitle":"List an entity's cross-linked peers","openapi":"/openapi/customer-api.json get /project/{projectId}/entities/{entityId}/crosslinks","href":"/api/endpoints/get-project-projectid-entities-entityid-crosslinks"},{"title":"Replace an entity's entire cross-link set","deprecated":null,"version":null,"sidebarTitle":"Replace an entity's entire cross-link set","openapi":"/openapi/customer-api.json put /project/{projectId}/entities/{entityId}/crosslinks","href":"/api/endpoints/put-project-projectid-entities-entityid-crosslinks"},{"title":"Cross-link an entity to a peer entity","deprecated":null,"version":null,"sidebarTitle":"Cross-link an entity to a peer entity","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/{entityId}/crosslinks","href":"/api/endpoints/post-project-projectid-entities-entityid-crosslinks"},{"title":"Remove a cross-link between two entities","deprecated":null,"version":null,"sidebarTitle":"Remove a cross-link between two entities","openapi":"/openapi/customer-api.json delete /project/{projectId}/entities/{entityId}/crosslinks/{crosslinkId}","href":"/api/endpoints/delete-project-projectid-entities-entityid-crosslinks-crosslinkid"},{"title":"Author (or clear) a formula on an entity field","deprecated":null,"version":null,"sidebarTitle":"Author (or clear) a formula on an entity field","openapi":"/openapi/customer-api.json put /project/{projectId}/entities/{entityId}/formulas","href":"/api/endpoints/put-project-projectid-entities-entityid-formulas"},{"title":"Add a link from an entity","deprecated":null,"version":null,"sidebarTitle":"Add a link from an entity","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/{entityId}/links","href":"/api/endpoints/post-project-projectid-entities-entityid-links"},{"title":"Remove a link from an entity","deprecated":null,"version":null,"sidebarTitle":"Remove a link from an entity","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/{entityId}/links/remove","href":"/api/endpoints/post-project-projectid-entities-entityid-links-remove"},{"title":"Restore a deleted entity","deprecated":null,"version":null,"sidebarTitle":"Restore a deleted entity","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/{entityId}/restore","href":"/api/endpoints/post-project-projectid-entities-entityid-restore"},{"title":"Set a value on an entity","deprecated":null,"version":null,"sidebarTitle":"Set a value on an entity","openapi":"/openapi/customer-api.json put /project/{projectId}/entities/{entityId}/values","href":"/api/endpoints/put-project-projectid-entities-entityid-values"},{"title":"Get current state of entities","deprecated":null,"version":null,"sidebarTitle":"Get current state of entities","openapi":"/openapi/customer-api.json get /project/{projectId}/entities/{entity_ids}","href":"/api/endpoints/get-project-projectid-entities-entity-ids"},{"title":"Reorder downstream links of an entity","deprecated":null,"version":null,"sidebarTitle":"Reorder downstream links of an entity","openapi":"/openapi/customer-api.json put /project/{projectId}/entities/{parentId}/children/reorder","href":"/api/endpoints/put-project-projectid-entities-parentid-children-reorder"}]},{"group":"Comments","pages":[{"title":"List comment threads or replies in a thread","deprecated":null,"version":null,"sidebarTitle":"List comment threads or replies in a thread","openapi":"/openapi/customer-api.json get /project/{projectId}/entities/{entityId}/comments","href":"/api/endpoints/get-project-projectid-entities-entityid-comments"},{"title":"Add a comment or reply in an existing thread","deprecated":null,"version":null,"sidebarTitle":"Add a comment or reply in an existing thread","openapi":"/openapi/customer-api.json post /project/{projectId}/entities/{entityId}/comments","href":"/api/endpoints/post-project-projectid-entities-entityid-comments"},{"title":"Get a single comment or reply","deprecated":null,"version":null,"sidebarTitle":"Get a single comment or reply","openapi":"/openapi/customer-api.json get /project/{projectId}/entities/{entityId}/comments/{commentId}","href":"/api/endpoints/get-project-projectid-entities-entityid-comments-commentid"},{"title":"Delete a comment or reply","deprecated":null,"version":null,"sidebarTitle":"Delete a comment or reply","openapi":"/openapi/customer-api.json delete /project/{projectId}/entities/{entityId}/comments/{commentId}","href":"/api/endpoints/delete-project-projectid-entities-entityid-comments-commentid"},{"title":"Update a comment (edit text and/or resolve)","deprecated":null,"version":null,"sidebarTitle":"Update a comment (edit text and/or resolve)","openapi":"/openapi/customer-api.json patch /project/{projectId}/entities/{entityId}/comments/{commentId}","href":"/api/endpoints/patch-project-projectid-entities-entityid-comments-commentid"}]},{"group":"Events","pages":[{"title":"Read the project event stream","deprecated":null,"version":null,"sidebarTitle":"Read the project event stream","openapi":"/openapi/customer-api.json get /project/{projectId}/events","href":"/api/endpoints/get-project-projectid-events"}]},{"group":"Files","pages":[{"title":"List the files uploaded to a project","deprecated":null,"version":null,"sidebarTitle":"List the files uploaded to a project","openapi":"/openapi/customer-api.json get /project/{projectId}/files","href":"/api/endpoints/get-project-projectid-files"},{"title":"Request a presigned upload URL","deprecated":null,"version":null,"sidebarTitle":"Request a presigned upload URL","openapi":"/openapi/customer-api.json post /project/{projectId}/files/request-upload","href":"/api/endpoints/post-project-projectid-files-request-upload"},{"title":"Request presigned upload URLs for multiple files","deprecated":null,"version":null,"sidebarTitle":"Request presigned upload URLs for multiple files","openapi":"/openapi/customer-api.json post /project/{projectId}/files/request-uploads","href":"/api/endpoints/post-project-projectid-files-request-uploads"},{"title":"Upload a file","deprecated":null,"version":null,"sidebarTitle":"Upload a file","openapi":"/openapi/customer-api.json post /project/{projectId}/files/upload","href":"/api/endpoints/post-project-projectid-files-upload"},{"title":"Get temporary download URLs for multiple files","deprecated":null,"version":null,"sidebarTitle":"Get temporary download URLs for multiple files","openapi":"/openapi/customer-api.json post /project/{projectId}/files/urls","href":"/api/endpoints/post-project-projectid-files-urls"},{"title":"Delete a file","deprecated":null,"version":null,"sidebarTitle":"Delete a file","openapi":"/openapi/customer-api.json delete /project/{projectId}/files/{id}","href":"/api/endpoints/delete-project-projectid-files-id"},{"title":"Request a presigned upload URL for an existing file","deprecated":null,"version":null,"sidebarTitle":"Request a presigned upload URL for an existing file","openapi":"/openapi/customer-api.json post /project/{projectId}/files/{id}/request-upload","href":"/api/endpoints/post-project-projectid-files-id-request-upload"},{"title":"Get a temporary download URL for a file","deprecated":null,"version":null,"sidebarTitle":"Get a temporary download URL for a file","openapi":"/openapi/customer-api.json get /project/{projectId}/files/{id}/url","href":"/api/endpoints/get-project-projectid-files-id-url"}]},{"group":"Import","pages":[{"title":"Render one PDF page as an image","deprecated":null,"version":null,"sidebarTitle":"Render one PDF page as an image","openapi":"/openapi/customer-api.json post /project/{projectId}/import/pdf-page-image","href":"/api/endpoints/post-project-projectid-import-pdf-page-image"},{"title":"List this project's recent import runs","deprecated":null,"version":null,"sidebarTitle":"List this project's recent import runs","openapi":"/openapi/customer-api.json get /project/{projectId}/import/runs","href":"/api/endpoints/get-project-projectid-import-runs"},{"title":"Start an import run over a set of uploaded files","deprecated":null,"version":null,"sidebarTitle":"Start an import run over a set of uploaded files","openapi":"/openapi/customer-api.json post /project/{projectId}/import/runs","href":"/api/endpoints/post-project-projectid-import-runs"},{"title":"Poll an import run","deprecated":null,"version":null,"sidebarTitle":"Poll an import run","openapi":"/openapi/customer-api.json get /project/{projectId}/import/runs/{runId}","href":"/api/endpoints/get-project-projectid-import-runs-runid"},{"title":"Stop an import run","deprecated":null,"version":null,"sidebarTitle":"Stop an import run","openapi":"/openapi/customer-api.json post /project/{projectId}/import/runs/{runId}/cancel","href":"/api/endpoints/post-project-projectid-import-runs-runid-cancel"},{"title":"Read an import run chunk by chunk","deprecated":null,"version":null,"sidebarTitle":"Read an import run chunk by chunk","openapi":"/openapi/customer-api.json get /project/{projectId}/import/runs/{runId}/chunks","href":"/api/endpoints/get-project-projectid-import-runs-runid-chunks"},{"title":"Read an import run rolled up across its chunks","deprecated":null,"version":null,"sidebarTitle":"Read an import run rolled up across its chunks","openapi":"/openapi/customer-api.json get /project/{projectId}/import/runs/{runId}/output","href":"/api/endpoints/get-project-projectid-import-runs-runid-output"}]},{"group":"ReqIF Import","pages":[{"title":"Request a presigned URL to upload a ReqIF archive","deprecated":null,"version":null,"sidebarTitle":"Request a presigned URL to upload a ReqIF archive","openapi":"/openapi/customer-api.json post /project/{projectId}/reqif-import/upload","href":"/api/endpoints/post-project-projectid-reqif-import-upload"},{"title":"Poll a ReqIF import job","deprecated":null,"version":null,"sidebarTitle":"Poll a ReqIF import job","openapi":"/openapi/customer-api.json get /project/{projectId}/reqif-import/{jobId}","href":"/api/endpoints/get-project-projectid-reqif-import-jobid"},{"title":"Commit a ReqIF import with the chosen mapping","deprecated":null,"version":null,"sidebarTitle":"Commit a ReqIF import with the chosen mapping","openapi":"/openapi/customer-api.json post /project/{projectId}/reqif-import/{jobId}/commit","href":"/api/endpoints/post-project-projectid-reqif-import-jobid-commit"},{"title":"Parse an uploaded ReqIF archive","deprecated":null,"version":null,"sidebarTitle":"Parse an uploaded ReqIF archive","openapi":"/openapi/customer-api.json post /project/{projectId}/reqif-import/{jobId}/parse","href":"/api/endpoints/post-project-projectid-reqif-import-jobid-parse"}]},{"group":"ReqIF","pages":[{"title":"Parse a ReqIF document into a flow-shaped preview","deprecated":null,"version":null,"sidebarTitle":"Parse a ReqIF document into a flow-shaped preview","openapi":"/openapi/customer-api.json post /reqif/parse","href":"/api/endpoints/post-reqif-parse"}]},{"group":"Review policy","pages":[{"title":"Read the review policy","deprecated":null,"version":null,"sidebarTitle":"Read the review policy","openapi":"/openapi/customer-api.json get /review-policy","href":"/api/endpoints/get-review-policy"},{"title":"Update the review policy","deprecated":null,"version":null,"sidebarTitle":"Update the review policy","openapi":"/openapi/customer-api.json patch /review-policy","href":"/api/endpoints/patch-review-policy"}]},{"group":"Shared Access Grants","pages":[{"title":"Create a shared-access grant","deprecated":null,"version":null,"sidebarTitle":"Create a shared-access grant","openapi":"/openapi/customer-api.json post /shared-grants","href":"/api/endpoints/post-shared-grants"},{"title":"List every shared-access grant in a project, including expired ones","deprecated":null,"version":null,"sidebarTitle":"List every shared-access grant in a project, including expired ones","openapi":"/openapi/customer-api.json get /shared-grants/project/{projectId}","href":"/api/endpoints/get-shared-grants-project-projectid"},{"title":"List active shared-access grants held by the current user in this project","deprecated":null,"version":null,"sidebarTitle":"List active shared-access grants held by the current user in this project","openapi":"/openapi/customer-api.json get /shared-grants/project/{projectId}/me","href":"/api/endpoints/get-shared-grants-project-projectid-me"},{"title":"Check whether the current external user can write the rendered share scope","deprecated":null,"version":null,"sidebarTitle":"Check whether the current external user can write the rendered share scope","openapi":"/openapi/customer-api.json get /shared-grants/project/{projectId}/me/can-write","href":"/api/endpoints/get-shared-grants-project-projectid-me-can-write"},{"title":"List active grants for the (project, branch, view, starting entity) scope","deprecated":null,"version":null,"sidebarTitle":"List active grants for the (project, branch, view, starting entity) scope","openapi":"/openapi/customer-api.json get /shared-grants/project/{projectId}/scope","href":"/api/endpoints/get-shared-grants-project-projectid-scope"},{"title":"Revoke a shared-access grant","deprecated":null,"version":null,"sidebarTitle":"Revoke a shared-access grant","openapi":"/openapi/customer-api.json delete /shared-grants/project/{projectId}/{id}","href":"/api/endpoints/delete-shared-grants-project-projectid-id"},{"title":"Replace the path above a shared item: individual item shares are added and removed to match","deprecated":null,"version":null,"sidebarTitle":"Replace the path above a shared item: individual item shares are added and removed to match","openapi":"/openapi/customer-api.json put /shared-grants/project/{projectId}/{id}/upstream-context","href":"/api/endpoints/put-shared-grants-project-projectid-id-upstream-context"},{"title":"Issue one grant per recipient under a single scope. Atomic across the batch.","deprecated":null,"version":null,"sidebarTitle":"Issue one grant per recipient under a single scope. Atomic across the batch.","openapi":"/openapi/customer-api.json post /shared-grants/share-view","href":"/api/endpoints/post-shared-grants-share-view"}]},{"group":"User Groups","pages":[{"title":"List user groups in the workspace","deprecated":null,"version":null,"sidebarTitle":"List user groups in the workspace","openapi":"/openapi/customer-api.json get /user-groups","href":"/api/endpoints/get-user-groups"},{"title":"Create a user group","deprecated":null,"version":null,"sidebarTitle":"Create a user group","openapi":"/openapi/customer-api.json post /user-groups","href":"/api/endpoints/post-user-groups"},{"title":"Delete a user group","deprecated":null,"version":null,"sidebarTitle":"Delete a user group","openapi":"/openapi/customer-api.json delete /user-groups/{id}","href":"/api/endpoints/delete-user-groups-id"},{"title":"Rename a user group or replace its members","deprecated":null,"version":null,"sidebarTitle":"Rename a user group or replace its members","openapi":"/openapi/customer-api.json patch /user-groups/{id}","href":"/api/endpoints/patch-user-groups-id"}]},{"group":"Users","pages":[{"title":"List all users","deprecated":null,"version":null,"sidebarTitle":"List all users","openapi":"/openapi/customer-api.json get /users","href":"/api/endpoints/get-users"},{"title":"Get users by ID","deprecated":null,"version":null,"sidebarTitle":"Get users by ID","openapi":"/openapi/customer-api.json get /users/by-ids","href":"/api/endpoints/get-users-by-ids"},{"title":"Invite users in bulk","deprecated":null,"version":null,"sidebarTitle":"Invite users in bulk","openapi":"/openapi/customer-api.json post /users/invite/bulk","href":"/api/endpoints/post-users-invite-bulk"},{"title":"Invite users with roles and access","deprecated":null,"version":null,"sidebarTitle":"Invite users with roles and access","openapi":"/openapi/customer-api.json post /users/invite/bulk-detailed","href":"/api/endpoints/post-users-invite-bulk-detailed"},{"title":"Get the current authenticated user","deprecated":null,"version":null,"sidebarTitle":"Get the current authenticated user","openapi":"/openapi/customer-api.json get /users/me","href":"/api/endpoints/get-users-me"},{"title":"List one page of users","deprecated":null,"version":null,"sidebarTitle":"List one page of users","openapi":"/openapi/customer-api.json get /users/page","href":"/api/endpoints/get-users-page"},{"title":"Remove the selected users from the workspace in one request. Users the caller cannot administer (or that no longer exist) are reported back as failed rather than removed.","deprecated":null,"version":null,"sidebarTitle":"Remove the selected users from the workspace in one request. Users the caller cannot administer (or that no longer exist) are reported back as failed rather than removed.","openapi":"/openapi/customer-api.json post /users/remove/bulk","href":"/api/endpoints/post-users-remove-bulk"},{"title":"List users with permissions","deprecated":null,"version":null,"sidebarTitle":"List users with permissions","openapi":"/openapi/customer-api.json get /users/with-permissions","href":"/api/endpoints/get-users-with-permissions"},{"title":"Get a user by ID","description":null,"deprecated":null,"version":null,"sidebarTitle":"Get a user by ID","openapi":"/openapi/customer-api.json get /users/{id}","href":"/api/endpoints/get-users-id"},{"title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","deprecated":null,"version":null,"sidebarTitle":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again.","openapi":"/openapi/customer-api.json delete /users/{id}","href":"/api/endpoints/delete-users-id"},{"title":"Update a user’s name in this workspace","description":"Requires an all-project admin. Replaces both name fields for the specified user, including users who have not signed in yet. Does not change email, role, or project access.","deprecated":null,"version":null,"sidebarTitle":"Update a user’s name in this workspace","openapi":"/openapi/customer-api.json patch /users/{id}/name","href":"/api/endpoints/patch-users-id-name"},{"title":"Get presigned URL for a user profile picture","deprecated":null,"version":null,"sidebarTitle":"Get presigned URL for a user profile picture","openapi":"/openapi/customer-api.json get /users/{id}/profile-picture-url","href":"/api/endpoints/get-users-id-profile-picture-url"}]}]}]},{"tab":"Release Notes","icon":{"name":"book-open","library":"lucide"},"pages":[{"title":"Release Notes","href":"/release-notes"}]}]},"basePath":"","title":"Remove a user from the workspace. Their account and authored content remain; they lose access until invited again. - Flow","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-DSVu9Ucl.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}
