Archive a planner item ({ "archived": true }, the default) or restore it ({ "archived": false }). Archived items leave the planner but keep their links, notes and history. Requires `planner.write` and write_planner.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"MSPortal.ai Documentation","colors":{"primary":"#0C8376","light":"#15B79E","dark":"#107569"},"logo":{"light":"https://mintcdn.com/msportal/KnbwIXtZSTlVJTt6/logo/light.svg?fit=max\u0026auto=format\u0026n=KnbwIXtZSTlVJTt6\u0026q=85\u0026s=eb69f6d6bf16b2c401770aef19ade1d2","dark":"https://mintcdn.com/msportal/KnbwIXtZSTlVJTt6/logo/dark.svg?fit=max\u0026auto=format\u0026n=KnbwIXtZSTlVJTt6\u0026q=85\u0026s=03f8df7191e7a8ea7da084df57f6107f"},"favicon":"https://mintcdn.com/msportal/KjsKytvp08K0bejm/favicon-16x16.png?fit=max\u0026auto=format\u0026n=KjsKytvp08K0bejm\u0026q=85\u0026s=378df7f039bbff7885231fec799d29ac","navbar":{"links":[{"href":"/release-notes/roadmap","label":"Roadmap"},{"href":"mailto:support@msportal.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.msportal.ai"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/msportal"},"links":[{"header":"Resources","items":[{"label":"MSPortal.ai","href":"https://msportal.ai"},{"label":"Support","href":"mailto:support@msportal.ai"},{"label":"Status","href":"https://status.msportal.ai"}]}]},"fonts":{"family":"Inter"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"msportal","hasAudioNarration":false,"actualSubdomain":"msportal","customDomains":["docs.msportal.ai"],"gitSource":{"type":"github","owner":"msportal-ai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae328b386c7ae22426d3366","collectionId":"15e079ba-d655-4ebc-a695-ee82947d9c1f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae328b386c7ae22426d3366"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae32edc51fbfc0519aa8feb","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"MSP Guides","count":457},{"language":"default","tag":"API Reference","count":423},{"language":"default","tag":"Operations","count":120},{"language":"default","tag":"Planning","count":101},{"language":"default","tag":"Integrations","count":92},{"language":"default","tag":"Projects","count":75},{"language":"default","tag":"Protection","count":58},{"language":"default","tag":"Standards","count":55},{"language":"default","tag":"Client Onboarding","count":48},{"language":"default","tag":"Compliance","count":44}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#page-title{font-size:1.75rem;line-height:2.125rem}#header .prose.text-lg{font-size:1rem;line-height:1.5rem;color:rgb(var(--gray-500))}#content-area .prose{font-size:.9375rem;line-height:1.6}#content-area .mdx-content{margin-top:1.5rem}#content-area .mdx-content h2{font-size:1.25rem;line-height:1.75rem;margin-top:2.25rem;margin-bottom:.75rem}#content-area .mdx-content h3{font-size:1.0625rem;line-height:1.5rem;margin-top:1.75rem;margin-bottom:.5rem}#content-area .mdx-content li{margin-top:.25em;margin-bottom:.25em}#content-area .steps{margin-top:1rem}#content-area .step{padding-bottom:.75rem}#content-area [data-component-part=step-title]{margin-top:.25rem;margin-bottom:.375rem}#sidebar-content li>a,#sidebar-content li>button{font-size:.875rem;line-height:1.25rem;padding-top:.3125rem;padding-bottom:.3125rem}#sidebar-content li>a span{hyphens:manual}#sidebar-content a.nav-anchor{margin-bottom:.25rem;font-size:.875rem}#sidebar-content ul:has(>li>a.nav-anchor){margin-bottom:1rem;padding-bottom:.5rem;border-bottom:1px solid rgb(var(--gray-100))}.dark #sidebar-content ul:has(>li>a.nav-anchor){border-bottom-color:rgb(255 255 255/.1)}#table-of-contents{font-size:.8125rem;line-height:1.25rem}#sidebar-content li>a>div:first-child:has(>svg,>img){display:none}:root{--sidebar-width:16rem}@media (min-width:1024px){#body-content,#navbar .max-w-8xl{max-width:none}#content-container{max-width:88rem;margin-left:0;padding-left:2.5rem;padding-right:2rem;column-gap:2.5rem;justify-content:space-between}}@media (min-width:1280px){#content-area{width:calc(100% - 16.5rem);max-width:52rem;margin-left:0}#navbar.is-wide~#body-content #content-container{max-width:none}#navbar.is-wide~#body-content #content-area{width:100%;max-width:none}#table-of-contents-layout{width:14rem;padding-left:0}#table-of-contents{width:14rem}}.roadmap-embed{display:block;border:0;background:0 0;color-scheme:light}.dark .roadmap-embed{color-scheme:dark}"}],"page":{"pagePath":"api-reference/planner/archive-planner-item","slug":"/api-reference/planner/archive-planner-item","pageMetadata":{"title":"Archive planner item","description":"Archive a planner item ({ \"archived\": true }, the default) or restore it ({ \"archived\": false }). Archived items leave the planner but keep their links, notes and history. Requires `planner.write` and write_planner.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/planner/items/{id}/archive","href":"/api-reference/planner/archive-planner-item","autogeneratedByOpenApi":true},"description":"Archive a planner item ({ \"archived\": true }, the default) or restore it ({ \"archived\": false }). Archived items leave the planner but keep their links, notes and history. Requires `planner.write` and write_planner.","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":"Archive planner item","description":"Archive a planner item ({ \"archived\": true }, the default) or restore it ({ \"archived\": false }). Archived items leave the planner but keep their links, notes and history. Requires `planner.write` and write_planner.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/planner/items/{id}/archive","href":"/api-reference/planner/archive-planner-item","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/msportal/d65dc731b8cde0aa/roadmap-embed.js"],"openApiReferenceData":{"operation":{"summary":"Archive planner item","description":"Archive a planner item ({ \"archived\": true }, the default) or restore it ({ \"archived\": false }). Archived items leave the planner but keep their links, notes and history. Requires `planner.write` and write_planner.","tags":["Planner"],"security":["20710784-8293-43bf-ac18-20fc3c30e0b8"],"parameters":["99af6d1c-dd76-4392-96b6-1fb65c944c5f"],"requestBody":"a5948f99-ecdb-44f7-a034-853d6f1b0c8b","responses":{"200":"aa92714f-6989-45b4-ae23-e61eeb2ac203","400":"bbc6c209-e705-4e43-92d6-e7ad093ebe26","401":"e86a2edb-d825-4d0c-b6fc-bcd100943bc8","403":"80493db2-d410-4128-95f9-91f14ae98737","404":"5650da5f-a32a-4b50-8ffb-a4dca74afce5"},"method":"post","type":"path","servers":["7ad251bc-7272-4bb5-8038-787c177f88e8","78580872-d2a5-4be1-9dda-1e799cd455eb"],"path":"/api/public/v1/planner/items/{id}/archive","baseUrlOptions":["https://app.msportal.ai","https://eu.msportal.ai"],"title":"Archive planner item","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"99af6d1c-dd76-4392-96b6-1fb65c944c5f":{"schema":{"type":"string","format":"uuid","description":"Planner item ID","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Planner item ID","name":"id","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"archived":{"type":"boolean","default":true,"description":"true archives the item (default); false restores it","uniqueKey":"archived","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"archived":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"aa92714f-6989-45b4-ae23-e61eeb2ac203":{"description":"The planner item after the change","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Planner item ID","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","description":"Item title","isRequired":true,"uniqueKey":"data.title","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Item description","isRequired":true,"uniqueKey":"data.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Item description","isRequired":true,"uniqueKey":"data.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.description","typeLabel":"string | null"},"status":{"type":"string","enum":["In Progress","Not Started","Completed","On Hold","Cancelled","Pending Approval"],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"businessValue":{"type":"string","enum":["High","Medium","Low"],"isRequired":true,"uniqueKey":"data.businessValue","typeLabel":"enum\u003cstring>"},"hours":{"type":"number","minimum":0,"description":"Estimated hours","isRequired":true,"uniqueKey":"data.hours","typeLabel":"number"},"costEstimate":{"type":"number","minimum":0,"description":"Cost estimate","isRequired":true,"uniqueKey":"data.costEstimate","typeLabel":"number"},"probability":{"type":"number","minimum":0,"maximum":100,"description":"Completion probability (0-100)","isRequired":true,"uniqueKey":"data.probability","typeLabel":"number"},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"Start date (ISO 8601)","isRequired":true,"uniqueKey":"data.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start date (ISO 8601)","isRequired":true,"uniqueKey":"data.startDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.startDate","typeLabel":"string\u003cdate-time> | null"},"dueDate":{"oneOf":[{"type":"string","format":"date-time","description":"Due date (ISO 8601)","isRequired":true,"uniqueKey":"data.dueDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Due date (ISO 8601)","isRequired":true,"uniqueKey":"data.dueDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.dueDate","typeLabel":"string\u003cdate-time> | null"},"endDate":{"oneOf":[{"type":"string","format":"date-time","description":"End date (ISO 8601)","isRequired":true,"uniqueKey":"data.endDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End date (ISO 8601)","isRequired":true,"uniqueKey":"data.endDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.endDate","typeLabel":"string\u003cdate-time> | null"},"publicNotes":{"oneOf":[{"type":"string","description":"Public notes (client-visible)","isRequired":true,"uniqueKey":"data.publicNotes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Public notes (client-visible)","isRequired":true,"uniqueKey":"data.publicNotes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.publicNotes","typeLabel":"string | null"},"privateNotes":{"oneOf":[{"type":"string","description":"Private notes (internal only, not visible to client portal users)","isRequired":true,"uniqueKey":"data.privateNotes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Private notes (internal only, not visible to client portal users)","isRequired":true,"uniqueKey":"data.privateNotes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.privateNotes","typeLabel":"string | null"},"isArchived":{"type":"boolean","description":"Whether the item is archived","isRequired":true,"uniqueKey":"data.isArchived","typeLabel":"boolean"},"isClientVisible":{"oneOf":[{"type":"boolean","description":"Whether company users can see this item; null if unknown. Does not override company scope or permissions.","isRequired":true,"uniqueKey":"data.isClientVisible.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether company users can see this item; null if unknown. Does not override company scope or permissions.","isRequired":true,"uniqueKey":"data.isClientVisible.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.isClientVisible","typeLabel":"boolean | null"},"isOverdue":{"type":"boolean","description":"Whether the item is overdue","isRequired":true,"uniqueKey":"data.isOverdue","typeLabel":"boolean"},"fiscalYear":{"oneOf":[{"type":"number","description":"Fiscal year","isRequired":true,"uniqueKey":"data.fiscalYear.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fiscal year","isRequired":true,"uniqueKey":"data.fiscalYear.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.fiscalYear","typeLabel":"number | null"},"fiscalQuarter":{"oneOf":[{"type":"number","description":"Fiscal quarter (1-4)","isRequired":true,"uniqueKey":"data.fiscalQuarter.oneOf.0","typeLabel":"number"},{"type":"null","description":"Fiscal quarter (1-4)","isRequired":true,"uniqueKey":"data.fiscalQuarter.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.fiscalQuarter","typeLabel":"number | null"},"company":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Company ID","isRequired":true,"uniqueKey":"data.company.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Company name","isRequired":true,"uniqueKey":"data.company.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.company.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Company ID"},"name":{"type":"string","description":"Company name"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.company.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.company","typeLabel":"object | null"},"type":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Type ID","isRequired":true,"uniqueKey":"data.type.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Type name","isRequired":true,"uniqueKey":"data.type.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.type.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Type ID"},"name":{"type":"string","description":"Type name"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.type","typeLabel":"object | null"},"linkedGoalsCount":{"type":"number","description":"Number of linked goals","isRequired":true,"uniqueKey":"data.linkedGoalsCount","typeLabel":"number"},"linkedComplianceCount":{"type":"number","description":"Number of linked compliance items","isRequired":true,"uniqueKey":"data.linkedComplianceCount","typeLabel":"number"},"linkedMeetingsCount":{"type":"number","description":"Number of linked meetings","isRequired":true,"uniqueKey":"data.linkedMeetingsCount","typeLabel":"number"},"linkedProjectsCount":{"type":"number","description":"Number of linked projects","isRequired":true,"uniqueKey":"data.linkedProjectsCount","typeLabel":"number"},"linkedSecureScoreCount":{"type":"number","description":"Number of linked secure score controls","isRequired":true,"uniqueKey":"data.linkedSecureScoreCount","typeLabel":"number"},"tagCount":{"type":"number","description":"Number of tags","isRequired":true,"uniqueKey":"data.tagCount","typeLabel":"number"},"createdAt":{"type":"string","format":"date-time","description":"Creation timestamp (ISO 8601)","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Last update timestamp (ISO 8601)","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","title","description","status","businessValue","hours","costEstimate","probability","startDate","dueDate","endDate","publicNotes","privateNotes","isArchived","isClientVisible","isOverdue","fiscalYear","fiscalQuarter","company","type","linkedGoalsCount","linkedComplianceCount","linkedMeetingsCount","linkedProjectsCount","linkedSecureScoreCount","tagCount","createdAt","updatedAt"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","description":"\u003cstring>","status":"In Progress","businessValue":"High","hours":1,"costEstimate":1,"probability":50,"startDate":"2023-11-07T05:31:56Z","dueDate":"2023-11-07T05:31:56Z","endDate":"2023-11-07T05:31:56Z","publicNotes":"\u003cstring>","privateNotes":"\u003cstring>","isArchived":true,"isClientVisible":true,"isOverdue":true,"fiscalYear":123,"fiscalQuarter":123,"company":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"type":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"},"linkedGoalsCount":123,"linkedComplianceCount":123,"linkedMeetingsCount":123,"linkedProjectsCount":123,"linkedSecureScoreCount":123,"tagCount":123,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"bbc6c209-e705-4e43-92d6-e7ad093ebe26":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"requestId":{"type":"string","description":"Request correlation ID","uniqueKey":"requestId","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Additional error details","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","requestId":"\u003cstring>","details":"\u003cunknown>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e86a2edb-d825-4d0c-b6fc-bcd100943bc8":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"requestId":{"type":"string","description":"Request correlation ID","uniqueKey":"requestId","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Additional error details","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","requestId":"\u003cstring>","details":"\u003cunknown>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"80493db2-d410-4128-95f9-91f14ae98737":{"description":"Forbidden - missing scope (planner.write) or the linked user lacks write_planner","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"requestId":{"type":"string","description":"Request correlation ID","uniqueKey":"requestId","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Additional error details","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","requestId":"\u003cstring>","details":"\u003cunknown>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5650da5f-a32a-4b50-8ffb-a4dca74afce5":{"description":"Planner item not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"requestId":{"type":"string","description":"Request correlation ID","uniqueKey":"requestId","typeLabel":"string"},"details":{"oneOf":[{"description":"Additional error details","uniqueKey":"details.oneOf.0","typeLabel":"any"},{"description":"Additional error details","type":"null","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"any | null"},"code":{"type":"string","description":"Error code","uniqueKey":"code","typeLabel":"string"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","requestId":"\u003cstring>","details":"\u003cunknown>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"20710784-8293-43bf-ac18-20fc3c30e0b8":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"7ad251bc-7272-4bb5-8038-787c177f88e8":{"url":"https://app.msportal.ai","description":"Production (US)"},"78580872-d2a5-4be1-9dda-1e799cd455eb":{"url":"https://eu.msportal.ai","description":"Production (EU)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"msportal","siteName":"MSPortal.ai Documentation","title":"Archive planner item - MSPortal.ai Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T11:33:45.195Z","originalFileLocation":"api-reference/planner/archive-planner-item.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=\"description\" content=\"Archive a planner item ({ \u0026quot;archived\u0026quot;: true }, the default) or restore it ({ \u0026quot;archived\u0026quot;: false }). Archived items leave the planner but keep their links, notes and history. Requires planner.write and write_planner.\">\u003cmeta data-mint-head name=\"application-name\" content=\"MSPortal.ai Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_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/msportal/MdEo74vho503Sp8Y/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Archive planner item - MSPortal.ai Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Archive a planner item ({ \u0026quot;archived\u0026quot;: true }, the default) or restore it ({ \u0026quot;archived\u0026quot;: false }). Archived items leave the planner but keep their links, notes and history. Requires planner.write and write_planner.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"MSPortal.ai Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.msportal.ai/api-reference/planner/archive-planner-item\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://msportal.mintlify.app/_mintlify/api/og/v2?division=Planner\u0026amp;title=Archive+planner+item\u0026amp;description=Archive+a+planner+item+%28%7B+%22archived%22%3A+true+%7D%2C+the+default%29+or+restore+it+%28%7B+%22archived%22%3A+false+%7D%29.+Archived+items+leave+the+planner+but+keep+their+links%2C+notes+a\u0026amp;theme=601404f1acc62abadd26bc13\u0026amp;signature=c18804f7eb2cb785a34d32c5cb8f6c0e8d584def8886ee405be5ca04eb6a1494\">\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=\"Archive planner item - MSPortal.ai Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Archive a planner item ({ \u0026quot;archived\u0026quot;: true }, the default) or restore it ({ \u0026quot;archived\u0026quot;: false }). Archived items leave the planner but keep their links, notes and history. Requires planner.write and write_planner.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://msportal.mintlify.app/_mintlify/api/og/v2?division=Planner\u0026amp;title=Archive+planner+item\u0026amp;description=Archive+a+planner+item+%28%7B+%22archived%22%3A+true+%7D%2C+the+default%29+or+restore+it+%28%7B+%22archived%22%3A+false+%7D%29.+Archived+items+leave+the+planner+but+keep+their+links%2C+notes+a\u0026amp;theme=601404f1acc62abadd26bc13\u0026amp;signature=c18804f7eb2cb785a34d32c5cb8f6c0e8d584def8886ee405be5ca04eb6a1494\">\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/msportal/MdEo74vho503Sp8Y/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"MSPortal.ai Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0C8376\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.msportal.ai/api-reference/planner/archive-planner-item\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/planner/archive-planner-item.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.msportal.ai/#organization\",\"name\":\"MSPortal.ai Documentation\",\"url\":\"https://docs.msportal.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/msportal/KnbwIXtZSTlVJTt6/logo/light.svg?fit=max\u0026auto=format\u0026n=KnbwIXtZSTlVJTt6\u0026q=85\u0026s=eb69f6d6bf16b2c401770aef19ade1d2\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.msportal.ai#website\",\"name\":\"MSPortal.ai Documentation\",\"url\":\"https://docs.msportal.ai\",\"publisher\":{\"@id\":\"https://docs.msportal.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item#webpage\",\"url\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item\",\"name\":\"Archive planner item\",\"description\":\"Archive a planner item ({ \\\"archived\\\": true }, the default) or restore it ({ \\\"archived\\\": false }). Archived items leave the planner but keep their links, notes and history. Requires planner.write and write_planner.\",\"dateModified\":\"2026-10-29T11:33:45.195Z\",\"isPartOf\":{\"@id\":\"https://docs.msportal.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Planner\",\"item\":\"https://docs.msportal.ai/api-reference/planner/list-planner-items\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Archive planner item\",\"item\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item#apireference\",\"headline\":\"Archive planner item\",\"name\":\"Archive planner item\",\"description\":\"Archive a planner item ({ \\\"archived\\\": true }, the default) or restore it ({ \\\"archived\\\": false }). Archived items leave the planner but keep their links, notes and history. Requires planner.write and write_planner.\",\"url\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item\",\"mainEntityOfPage\":{\"@id\":\"https://docs.msportal.ai/api-reference/planner/archive-planner-item#webpage\"},\"dateModified\":\"2026-10-29T11:33:45.195Z\",\"publisher\":{\"@id\":\"https://docs.msportal.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.msportal.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"MSPortal.ai Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"MSPortal.ai Documentation","nav":{"global":null,"tabs":[{"tab":"Company Guides","pages":[{"title":"Company Guides","href":"/user-guides/account/manage-your-profile"}]},{"tab":"MSP Guides","pages":[{"title":"MSP Guides","href":"/user-guides/getting-started"}]},{"tab":"API Reference","groups":[{"group":"Budgets","pages":[{"title":"List budgets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets","href":"/api-reference/budgets/list-budgets"},{"title":"Create budget","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets","href":"/api-reference/budgets/create-budget"},{"title":"Get budget","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets/{id}","href":"/api-reference/budgets/get-budget"},{"title":"Delete budget","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/budgets/{id}","href":"/api-reference/budgets/delete-budget"},{"title":"Update budget","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/budgets/{id}","href":"/api-reference/budgets/update-budget"},{"title":"Create budget line item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets/{id}/items","href":"/api-reference/budgets/create-budget-line-item"},{"title":"Delete budget line item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/budgets/{id}/items/{itemId}","href":"/api-reference/budgets/delete-budget-line-item"},{"title":"Update budget line item","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/budgets/{id}/items/{itemId}","href":"/api-reference/budgets/update-budget-line-item"},{"title":"List budget categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets/categories","href":"/api-reference/budgets/list-budget-categories"},{"title":"List budget products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets/products","href":"/api-reference/budgets/list-budget-products"},{"title":"Get budget forecast","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets/forecast","href":"/api-reference/budgets/get-budget-forecast"},{"title":"List budget approver options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets/{id}/approver-options","href":"/api-reference/budgets/list-budget-approver-options"},{"title":"Submit budget for approval","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets/{id}/approval/submit","href":"/api-reference/budgets/submit-budget-for-approval"},{"title":"Withdraw budget approval","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets/{id}/approval/withdraw","href":"/api-reference/budgets/withdraw-budget-approval"},{"title":"Request budget review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets/{id}/review/request","href":"/api-reference/budgets/request-budget-review"},{"title":"Cancel budget review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets/{id}/review/cancel","href":"/api-reference/budgets/cancel-budget-review"},{"title":"Respond to budget review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/budgets/{id}/review/respond","href":"/api-reference/budgets/respond-to-budget-review"},{"title":"List budget approval history","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/budgets/{id}/approval-events","href":"/api-reference/budgets/list-budget-approval-history"}]},{"group":"Calendar","pages":[{"title":"List meetings","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/meetings","href":"/api-reference/calendar/list-meetings"},{"title":"Create meeting","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/calendar/meetings","href":"/api-reference/calendar/create-meeting"},{"title":"Get meeting","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/meetings/{id}","href":"/api-reference/calendar/get-meeting"},{"title":"Cancel a meeting series or occurrence","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/calendar/meetings/{id}","href":"/api-reference/calendar/cancel-a-meeting-series-or-occurrence"},{"title":"Update a meeting series or occurrence","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/calendar/meetings/{id}","href":"/api-reference/calendar/update-a-meeting-series-or-occurrence"},{"title":"List meeting types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/types","href":"/api-reference/calendar/list-meeting-types"},{"title":"Get meeting type","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/types/{id}","href":"/api-reference/calendar/get-meeting-type"},{"title":"List meeting agenda","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/meetings/{id}/agenda","href":"/api-reference/calendar/list-meeting-agenda"},{"title":"Add meeting agenda items","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/calendar/meetings/{id}/agenda","href":"/api-reference/calendar/add-meeting-agenda-items"},{"title":"Reorder a meeting agenda item","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/calendar/meetings/{id}/agenda/{agendaItemId}/position","href":"/api-reference/calendar/reorder-a-meeting-agenda-item"},{"title":"Remove a meeting agenda item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/calendar/agenda-items/{agendaItemId}","href":"/api-reference/calendar/remove-a-meeting-agenda-item"},{"title":"List meeting action items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/meetings/{id}/action-items","href":"/api-reference/calendar/list-meeting-action-items"},{"title":"Add a meeting action item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/calendar/meetings/{id}/action-items","href":"/api-reference/calendar/add-a-meeting-action-item"},{"title":"Update a meeting action item","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/calendar/action-items/{actionItemId}","href":"/api-reference/calendar/update-a-meeting-action-item"},{"title":"List meeting participants","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/meetings/{id}/participants","href":"/api-reference/calendar/list-meeting-participants"},{"title":"Add meeting participants","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/calendar/meetings/{id}/participants","href":"/api-reference/calendar/add-meeting-participants"},{"title":"Remove a meeting participant","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/calendar/meetings/{id}/participants","href":"/api-reference/calendar/remove-a-meeting-participant"},{"title":"Retry meeting publication","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/calendar/meetings/{id}/retry-publication","href":"/api-reference/calendar/retry-meeting-publication"},{"title":"Get the business review plan","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/calendar/business-review-plan","href":"/api-reference/calendar/get-the-business-review-plan"},{"title":"Set business review targets","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/calendar/business-review-plan/targets","href":"/api-reference/calendar/set-business-review-targets"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/companies","href":"/api-reference/companies/list-companies"},{"title":"Create company","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/companies","href":"/api-reference/companies/create-company"},{"title":"Get company","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/companies/{id}","href":"/api-reference/companies/get-company"},{"title":"Update company","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/companies/{id}","href":"/api-reference/companies/update-company"},{"title":"Delete company","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/companies/{id}","href":"/api-reference/companies/delete-company"},{"title":"Get company defaults","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/companies/{id}/defaults","href":"/api-reference/companies/get-company-defaults"},{"title":"Update company defaults","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/companies/{id}/defaults","href":"/api-reference/companies/update-company-defaults"},{"title":"List company account notes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/companies/{id}/account-notes","href":"/api-reference/companies/list-company-account-notes"}]},{"group":"Company Users","pages":[{"title":"List company users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/companies/users","href":"/api-reference/company-users/list-company-users"},{"title":"Create company user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/companies/users","href":"/api-reference/company-users/create-company-user"},{"title":"Get company user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/companies/users/{id}","href":"/api-reference/company-users/get-company-user"}]},{"group":"Compliance","pages":[{"title":"List compliance runs","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/runs","href":"/api-reference/compliance/list-compliance-runs"},{"title":"Create compliance runs","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/runs","href":"/api-reference/compliance/create-compliance-runs"},{"title":"Get compliance run","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/runs/{id}","href":"/api-reference/compliance/get-compliance-run"},{"title":"Update a compliance run","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/runs/{id}","href":"/api-reference/compliance/update-a-compliance-run"},{"title":"List assigned compliance checks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/checks","href":"/api-reference/compliance/list-assigned-compliance-checks"},{"title":"Update assigned checks in bulk","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/checks","href":"/api-reference/compliance/update-assigned-checks-in-bulk"},{"title":"Get assigned compliance check","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/checks/{id}","href":"/api-reference/compliance/get-assigned-compliance-check"},{"title":"Update assigned compliance check","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/checks/{id}","href":"/api-reference/compliance/update-assigned-compliance-check"},{"title":"List compliance groups","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/groups","href":"/api-reference/compliance/list-compliance-groups"},{"title":"Create a compliance group","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/groups","href":"/api-reference/compliance/create-a-compliance-group"},{"title":"Get compliance group","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/groups/{id}","href":"/api-reference/compliance/get-compliance-group"},{"title":"Delete a compliance group","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/compliance/groups/{id}","href":"/api-reference/compliance/delete-a-compliance-group"},{"title":"Update a compliance group","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/groups/{id}","href":"/api-reference/compliance/update-a-compliance-group"},{"title":"List compliance templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/templates","href":"/api-reference/compliance/list-compliance-templates"},{"title":"Create a compliance check definition","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/templates","href":"/api-reference/compliance/create-a-compliance-check-definition"},{"title":"Get compliance template","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/templates/{id}","href":"/api-reference/compliance/get-compliance-template"},{"title":"Delete a compliance check definition","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/compliance/templates/{id}","href":"/api-reference/compliance/delete-a-compliance-check-definition"},{"title":"Update a compliance check definition","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/templates/{id}","href":"/api-reference/compliance/update-a-compliance-check-definition"},{"title":"Get compliance company summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/company-summary","href":"/api-reference/compliance/get-compliance-company-summary"},{"title":"List status options for an assigned check","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/checks/{id}/status-options","href":"/api-reference/compliance/list-status-options-for-an-assigned-check"},{"title":"List compliance run templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/run-templates","href":"/api-reference/compliance/list-compliance-run-templates"},{"title":"Create a compliance run template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/run-templates","href":"/api-reference/compliance/create-a-compliance-run-template"},{"title":"Get a compliance run template","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/run-templates/{id}","href":"/api-reference/compliance/get-a-compliance-run-template"},{"title":"Delete a compliance run template","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/compliance/run-templates/{id}","href":"/api-reference/compliance/delete-a-compliance-run-template"},{"title":"Update a compliance run template","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/run-templates/{id}","href":"/api-reference/compliance/update-a-compliance-run-template"},{"title":"Draft public compliance notes","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/note-drafts","href":"/api-reference/compliance/draft-public-compliance-notes"},{"title":"List compliance risks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/risks","href":"/api-reference/compliance/list-compliance-risks"},{"title":"Promote a compliance gap into a risk","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/risks","href":"/api-reference/compliance/promote-a-compliance-gap-into-a-risk"},{"title":"Get a compliance risk","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/risks/{id}","href":"/api-reference/compliance/get-a-compliance-risk"},{"title":"Update a compliance risk","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/compliance/risks/{id}","href":"/api-reference/compliance/update-a-compliance-risk"},{"title":"List compliance risk categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/risk-categories","href":"/api-reference/compliance/list-compliance-risk-categories"},{"title":"List compliance risk gaps","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/risk-gaps","href":"/api-reference/compliance/list-compliance-risk-gaps"},{"title":"Get a compliance risk gap","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/compliance/risk-gaps/{id}","href":"/api-reference/compliance/get-a-compliance-risk-gap"},{"title":"Dismiss a compliance risk gap","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/compliance/risk-gaps/{id}/dismiss","href":"/api-reference/compliance/dismiss-a-compliance-risk-gap"}]},{"group":"Dashboards","pages":[{"title":"List external dashboards","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/dashboards/external","href":"/api-reference/dashboards/list-external-dashboards"},{"title":"Create external dashboard","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/dashboards/external","href":"/api-reference/dashboards/create-external-dashboard"},{"title":"Get external dashboard","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/dashboards/external/{id}","href":"/api-reference/dashboards/get-external-dashboard"},{"title":"Get company URLs for external dashboard","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/dashboards/external/{id}/company-urls","href":"/api-reference/dashboards/get-company-urls-for-external-dashboard"},{"title":"Set company URLs for external dashboard","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/dashboards/external/{id}/company-urls","href":"/api-reference/dashboards/set-company-urls-for-external-dashboard"},{"title":"List internal dashboards","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/dashboards/internal","href":"/api-reference/dashboards/list-internal-dashboards"}]},{"group":"Devices","pages":[{"title":"List devices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices","href":"/api-reference/devices/list-devices"},{"title":"Get device","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/{id}","href":"/api-reference/devices/get-device"},{"title":"List device types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/types","href":"/api-reference/devices/list-device-types"},{"title":"Get device type","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/types/{id}","href":"/api-reference/devices/get-device-type"},{"title":"List locations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/locations","href":"/api-reference/devices/list-locations"},{"title":"Get location","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/locations/{id}","href":"/api-reference/devices/get-location"},{"title":"List device alerts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/alerts","href":"/api-reference/devices/list-device-alerts"},{"title":"Get device summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/summary","href":"/api-reference/devices/get-device-summary"},{"title":"Get device patch health","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/patch-health","href":"/api-reference/devices/get-device-patch-health"},{"title":"List Intune policies","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/intune/policies","href":"/api-reference/devices/list-intune-policies"},{"title":"Get Intune policy","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/intune/policies/{id}","href":"/api-reference/devices/get-intune-policy"},{"title":"List Intune devices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/intune/devices","href":"/api-reference/devices/list-intune-devices"},{"title":"Get software inventory overview","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/software/overview","href":"/api-reference/devices/get-software-inventory-overview"},{"title":"List software products","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/software/products","href":"/api-reference/devices/list-software-products"},{"title":"Get software product","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/software/products/{id}","href":"/api-reference/devices/get-software-product"},{"title":"List devices with a software product installed","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/devices/software/products/{id}/devices","href":"/api-reference/devices/list-devices-with-a-software-product-installed"}]},{"group":"Goals","pages":[{"title":"List goals","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/goals","href":"/api-reference/goals/list-goals"},{"title":"Create goal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/goals","href":"/api-reference/goals/create-goal"},{"title":"Get goal","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/goals/{id}","href":"/api-reference/goals/get-goal"},{"title":"Delete goal","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/goals/{id}","href":"/api-reference/goals/delete-goal"},{"title":"Update goal","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/goals/{id}","href":"/api-reference/goals/update-goal"},{"title":"List goal status options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/goals/status-options","href":"/api-reference/goals/list-goal-status-options"},{"title":"List goal priority options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/goals/priority-options","href":"/api-reference/goals/list-goal-priority-options"},{"title":"List goal categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/goals/categories","href":"/api-reference/goals/list-goal-categories"}]},{"group":"Surveys","pages":[{"title":"List general surveys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys","href":"/api-reference/surveys/list-general-surveys"},{"title":"Create a general survey","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/surveys","href":"/api-reference/surveys/create-a-general-survey"},{"title":"Get general survey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/{id}","href":"/api-reference/surveys/get-general-survey"},{"title":"List survey responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/{id}/responses","href":"/api-reference/surveys/list-survey-responses"},{"title":"Get survey statistics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/{id}/stats","href":"/api-reference/surveys/get-survey-statistics"},{"title":"Send survey invites","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/surveys/{id}/invites","href":"/api-reference/surveys/send-survey-invites"},{"title":"Set survey status","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/surveys/{id}/status","href":"/api-reference/surveys/set-survey-status"},{"title":"Get a general survey's share link","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/{id}/share-link","href":"/api-reference/surveys/get-a-general-surveys-share-link"},{"title":"Create or update a general survey's share link","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/surveys/{id}/share-link","href":"/api-reference/surveys/create-or-update-a-general-surveys-share-link"},{"title":"List the CSAT review queue","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/csat-reviews","href":"/api-reference/surveys/list-the-csat-review-queue"},{"title":"Get a CSAT review","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/csat-reviews/{id}","href":"/api-reference/surveys/get-a-csat-review"},{"title":"Get the CSAT review of a response","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/csat-reviews/by-response/{responseId}","href":"/api-reference/surveys/get-the-csat-review-of-a-response"},{"title":"Decide a CSAT review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/surveys/csat-reviews/{id}/decision","href":"/api-reference/surveys/decide-a-csat-review"}]},{"group":"NPS Surveys","pages":[{"title":"List NPS surveys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/nps","href":"/api-reference/nps-surveys/list-nps-surveys"},{"title":"Get NPS survey","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/nps/{id}","href":"/api-reference/nps-surveys/get-nps-survey"},{"title":"List NPS responses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/nps/responses","href":"/api-reference/nps-surveys/list-nps-responses"},{"title":"Get NPS analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/nps/{id}/analytics","href":"/api-reference/nps-surveys/get-nps-analytics"},{"title":"Get a NPS survey's share link","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/nps/{id}/share-link","href":"/api-reference/nps-surveys/get-a-nps-surveys-share-link"},{"title":"Create or update a NPS survey's share link","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/surveys/nps/{id}/share-link","href":"/api-reference/nps-surveys/create-or-update-a-nps-surveys-share-link"},{"title":"Get NPS summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/surveys/nps/analytics","href":"/api-reference/nps-surveys/get-nps-summary"}]},{"group":"Tickets","pages":[{"title":"List tickets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets","href":"/api-reference/tickets/list-tickets"},{"title":"Create ticket","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tickets","href":"/api-reference/tickets/create-ticket"},{"title":"Get ticket","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets/{id}","href":"/api-reference/tickets/get-ticket"},{"title":"List ticket notes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets/{id}/notes","href":"/api-reference/tickets/list-ticket-notes"},{"title":"Add ticket note","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tickets/{id}/notes","href":"/api-reference/tickets/add-ticket-note"},{"title":"Update ticket status","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/tickets/{id}/status","href":"/api-reference/tickets/update-ticket-status"},{"title":"List ticket status options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets/{id}/status-options","href":"/api-reference/tickets/list-ticket-status-options"},{"title":"List ticket note recipient options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets/{id}/note-recipient-options","href":"/api-reference/tickets/list-ticket-note-recipient-options"},{"title":"Retry customer reply status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tickets/{id}/reply-status/retry","href":"/api-reference/tickets/retry-customer-reply-status"},{"title":"List ticket approvals","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets/approvals","href":"/api-reference/tickets/list-ticket-approvals"},{"title":"Get ticket approval","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tickets/approvals/{requestId}","href":"/api-reference/tickets/get-ticket-approval"},{"title":"Decide ticket approval","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tickets/approvals/{requestId}/decide","href":"/api-reference/tickets/decide-ticket-approval"},{"title":"Read Halo problems and resolution progress","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/problems","href":"/api-reference/tickets/read-halo-problems-and-resolution-progress"}]},{"group":"Planner","pages":[{"title":"List planner items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/planner/items","href":"/api-reference/planner/list-planner-items"},{"title":"Create planner item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/planner/items","href":"/api-reference/planner/create-planner-item"},{"title":"Get planner item","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/planner/items/{id}","href":"/api-reference/planner/get-planner-item"},{"title":"Delete planner item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/planner/items/{id}","href":"/api-reference/planner/delete-planner-item"},{"title":"Update planner item","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/planner/items/{id}","href":"/api-reference/planner/update-planner-item"},{"title":"List planner item types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/planner/types","href":"/api-reference/planner/list-planner-item-types"},{"title":"Get planner item type","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/planner/types/{id}","href":"/api-reference/planner/get-planner-item-type"},{"title":"List planner item links","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/planner/items/{id}/links","href":"/api-reference/planner/list-planner-item-links"},{"title":"Link entities to planner item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/planner/items/{id}/links","href":"/api-reference/planner/link-entities-to-planner-item"},{"title":"Unlink entity from planner item","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/planner/items/{id}/links/{entityType}/{entityId}","href":"/api-reference/planner/unlink-entity-from-planner-item"},{"title":"Merge planner items","description":"Merge duplicate planner items of one company into a single item. targetId is kept; sourceIds are merged into it: linked devices, tickets, licenses, goals, projects, compliance and other records, cost lines, notes, attachments, tasks and draft budget lines move to the kept item, hours add up, and the merged items are archived (restore one with PATCH /planner/items/{id} isArchived=false). Items kept in sync by a standard or an automation rule, and items whose devices are kept linked by conditions, cannot be merged. MSP staff with Planner manage permission only. Requires `planner.write` and manage_planner.","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/planner/items/merge","href":"/api-reference/planner/merge-planner-items"},{"title":"Archive planner item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/planner/items/{id}/archive","href":"/api-reference/planner/archive-planner-item"},{"title":"Keep planner item devices linked","description":"Turn \"Keep linked automatically\" on or off for a planner item. With criteria, the item's device links become exactly the company's matching devices now, and an hourly refresh links newly synced matches and unlinks devices that stop matching. criteria=null turns it off and keeps the current links. Preview the matches with device-suggestions first. Items managed by standards or an automation rule are refused. Requires `planner.write` and write_planner.","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/planner/items/{id}/device-criteria","href":"/api-reference/planner/keep-planner-item-devices-linked"},{"title":"Suggest planner item devices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/planner/items/{id}/device-suggestions","href":"/api-reference/planner/suggest-planner-item-devices"}]},{"group":"Reports","pages":[{"title":"List reports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/reports","href":"/api-reference/reports/list-reports"},{"title":"Create report","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/reports","href":"/api-reference/reports/create-report"},{"title":"Get report","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/reports/{id}","href":"/api-reference/reports/get-report"},{"title":"Delete report","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/reports/{id}","href":"/api-reference/reports/delete-report"},{"title":"Update report","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/reports/{id}","href":"/api-reference/reports/update-report"},{"title":"List report templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/report-templates","href":"/api-reference/reports/list-report-templates"},{"title":"Get report template","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/report-templates/{id}","href":"/api-reference/reports/get-report-template"},{"title":"List report types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/report-types","href":"/api-reference/reports/list-report-types"},{"title":"List report schedules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/report-schedules","href":"/api-reference/reports/list-report-schedules"},{"title":"Get report schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/report-schedules/{id}","href":"/api-reference/reports/get-report-schedule"},{"title":"Publish report","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/reports/{id}/publish","href":"/api-reference/reports/publish-report"},{"title":"Run report schedule now","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/report-schedules/{id}/run","href":"/api-reference/reports/run-report-schedule-now"}]},{"group":"Automation Rules","pages":[{"title":"List automation rules","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/automation","href":"/api-reference/automation-rules/list-automation-rules"},{"title":"Create automation rule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/automation","href":"/api-reference/automation-rules/create-automation-rule"},{"title":"Get automation rule","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/automation/{id}","href":"/api-reference/automation-rules/get-automation-rule"},{"title":"Delete automation rule","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/automation/{id}","href":"/api-reference/automation-rules/delete-automation-rule"},{"title":"Update automation rule","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/automation/{id}","href":"/api-reference/automation-rules/update-automation-rule"},{"title":"Toggle rule active status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/automation/{id}/toggle","href":"/api-reference/automation-rules/toggle-rule-active-status"},{"title":"List rule executions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/automation/{id}/executions","href":"/api-reference/automation-rules/list-rule-executions"},{"title":"List all rule executions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/automation/executions","href":"/api-reference/automation-rules/list-all-rule-executions"},{"title":"List trigger types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/automation/trigger-types","href":"/api-reference/automation-rules/list-trigger-types"},{"title":"List entity types","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/automation/entity-types","href":"/api-reference/automation-rules/list-entity-types"}]},{"group":"Training","pages":[{"title":"List training courses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/courses","href":"/api-reference/training/list-training-courses"},{"title":"Create training course","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/training/courses","href":"/api-reference/training/create-training-course"},{"title":"Get training course","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/courses/{id}","href":"/api-reference/training/get-training-course"},{"title":"Delete training course","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/training/courses/{id}","href":"/api-reference/training/delete-training-course"},{"title":"Update training course","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/training/courses/{id}","href":"/api-reference/training/update-training-course"},{"title":"List enrollments","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/enrollments","href":"/api-reference/training/list-enrollments"},{"title":"Create enrollment","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/training/enrollments","href":"/api-reference/training/create-enrollment"},{"title":"Get enrollment","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/enrollments/{id}","href":"/api-reference/training/get-enrollment"},{"title":"Delete enrollment","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/training/enrollments/{id}","href":"/api-reference/training/delete-enrollment"},{"title":"Update enrollment","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/training/enrollments/{id}","href":"/api-reference/training/update-enrollment"},{"title":"Bulk enroll users","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/training/enrollments/bulk","href":"/api-reference/training/bulk-enroll-users"},{"title":"List certificates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/certificates","href":"/api-reference/training/list-certificates"},{"title":"Get certificate","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/certificates/{id}","href":"/api-reference/training/get-certificate"},{"title":"List training categories","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/categories","href":"/api-reference/training/list-training-categories"},{"title":"Get Phished training and simulation insights","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/training/phished","href":"/api-reference/training/get-phished-training-and-simulation-insights"},{"title":"Set training course availability","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/training/courses/{id}/availability","href":"/api-reference/training/set-training-course-availability"}]},{"group":"Users","pages":[{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/users","href":"/api-reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/users","href":"/api-reference/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/users/{id}","href":"/api-reference/users/get-user"},{"title":"Invite user","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/users/invite","href":"/api-reference/users/invite-user"},{"title":"Set user status","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/users/{id}/status","href":"/api-reference/users/set-user-status"}]},{"group":"Analytics","pages":[{"title":"List company audit data","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/company-audit","href":"/api-reference/analytics/list-company-audit-data"},{"title":"Get training analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/training","href":"/api-reference/analytics/get-training-analytics"},{"title":"Get user activity analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/user-activity","href":"/api-reference/analytics/get-user-activity-analytics"},{"title":"Get portfolio summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/portfolio","href":"/api-reference/analytics/get-portfolio-summary"},{"title":"Get team activity","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/team-activity","href":"/api-reference/analytics/get-team-activity"},{"title":"Get ticket trends","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/ticket-trends","href":"/api-reference/analytics/get-ticket-trends"},{"title":"Get technician capacity","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/technician-capacity","href":"/api-reference/analytics/get-technician-capacity"},{"title":"Get technician capacity forecast","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/analytics/technician-forecast","href":"/api-reference/analytics/get-technician-capacity-forecast"}]},{"group":"Client Onboarding","pages":[{"title":"List onboarding portals","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/portals","href":"/api-reference/client-onboarding/list-onboarding-portals"},{"title":"Create onboarding portal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/portals","href":"/api-reference/client-onboarding/create-onboarding-portal"},{"title":"Get onboarding portal","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/portals/{id}","href":"/api-reference/client-onboarding/get-onboarding-portal"},{"title":"Update onboarding portal","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/portals/{id}","href":"/api-reference/client-onboarding/update-onboarding-portal"},{"title":"Start onboarding portal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/portals/{id}/start","href":"/api-reference/client-onboarding/start-onboarding-portal"},{"title":"Complete onboarding portal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/portals/{id}/complete","href":"/api-reference/client-onboarding/complete-onboarding-portal"},{"title":"Archive or unarchive onboarding portal","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/portals/{id}/archive","href":"/api-reference/client-onboarding/archive-or-unarchive-onboarding-portal"},{"title":"Add onboarding portal contact","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/portals/{id}/contacts","href":"/api-reference/client-onboarding/add-onboarding-portal-contact"},{"title":"Add onboarding portal phase","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/portals/{id}/phases","href":"/api-reference/client-onboarding/add-onboarding-portal-phase"},{"title":"Update onboarding portal phase","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/phases/{phaseId}","href":"/api-reference/client-onboarding/update-onboarding-portal-phase"},{"title":"Add onboarding portal task","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/phases/{phaseId}/tasks","href":"/api-reference/client-onboarding/add-onboarding-portal-task"},{"title":"Delete onboarding portal task","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/onboarding/tasks/{taskId}","href":"/api-reference/client-onboarding/delete-onboarding-portal-task"},{"title":"Update onboarding portal task","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/tasks/{taskId}","href":"/api-reference/client-onboarding/update-onboarding-portal-task"},{"title":"Set onboarding task status","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/onboarding/tasks/{taskId}/status","href":"/api-reference/client-onboarding/set-onboarding-task-status"},{"title":"List onboarding templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/templates","href":"/api-reference/client-onboarding/list-onboarding-templates"},{"title":"List checklist templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/checklists","href":"/api-reference/client-onboarding/list-checklist-templates"},{"title":"Create checklist template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/checklists","href":"/api-reference/client-onboarding/create-checklist-template"},{"title":"Get checklist template","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/checklists/{id}","href":"/api-reference/client-onboarding/get-checklist-template"},{"title":"Update checklist template","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/checklists/{id}","href":"/api-reference/client-onboarding/update-checklist-template"},{"title":"Archive or restore checklist template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/checklists/{id}/archive","href":"/api-reference/client-onboarding/archive-or-restore-checklist-template"},{"title":"List onboarding forms","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/forms","href":"/api-reference/client-onboarding/list-onboarding-forms"},{"title":"Create onboarding form","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/forms","href":"/api-reference/client-onboarding/create-onboarding-form"},{"title":"Get onboarding form","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/forms/{id}","href":"/api-reference/client-onboarding/get-onboarding-form"},{"title":"Update onboarding form","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/forms/{id}","href":"/api-reference/client-onboarding/update-onboarding-form"},{"title":"List onboarding documentation pages","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/pages","href":"/api-reference/client-onboarding/list-onboarding-documentation-pages"},{"title":"Create onboarding documentation page","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/pages","href":"/api-reference/client-onboarding/create-onboarding-documentation-page"},{"title":"Get onboarding documentation page","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/onboarding/pages/{id}","href":"/api-reference/client-onboarding/get-onboarding-documentation-page"},{"title":"Delete onboarding documentation page","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/onboarding/pages/{id}","href":"/api-reference/client-onboarding/delete-onboarding-documentation-page"},{"title":"Update onboarding documentation page","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/pages/{id}","href":"/api-reference/client-onboarding/update-onboarding-documentation-page"},{"title":"Link documentation page to template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/onboarding/template-page-links","href":"/api-reference/client-onboarding/link-documentation-page-to-template"},{"title":"Unlink documentation page from template","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/onboarding/template-page-links/{linkId}","href":"/api-reference/client-onboarding/unlink-documentation-page-from-template"},{"title":"Update template page link","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/onboarding/template-page-links/{linkId}","href":"/api-reference/client-onboarding/update-template-page-link"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Get project","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}","href":"/api-reference/projects/get-project"},{"title":"Get project detail bundle","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/detail","href":"/api-reference/projects/get-project-detail-bundle"},{"title":"List project tickets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/tickets","href":"/api-reference/projects/list-project-tickets"},{"title":"List project time entries","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/time-entries","href":"/api-reference/projects/list-project-time-entries"},{"title":"Get project Kanban options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/kanban-options","href":"/api-reference/projects/get-project-kanban-options"},{"title":"List assignable users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/assignable-users","href":"/api-reference/projects/list-assignable-users"},{"title":"Update project overlay","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/projects/{id}/overlay","href":"/api-reference/projects/update-project-overlay"},{"title":"Set project client visibility","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/projects/{id}/client-visibility","href":"/api-reference/projects/set-project-client-visibility"},{"title":"Create project deliverable","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/deliverables","href":"/api-reference/projects/create-project-deliverable"},{"title":"Delete project deliverable","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/projects/{id}/deliverables/{deliverableId}","href":"/api-reference/projects/delete-project-deliverable"},{"title":"Update project deliverable","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/projects/{id}/deliverables/{deliverableId}","href":"/api-reference/projects/update-project-deliverable"},{"title":"Set deliverable document visibility","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/projects/{id}/deliverables/{deliverableId}/documents/{documentId}/visibility","href":"/api-reference/projects/set-deliverable-document-visibility"},{"title":"Create project milestone","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/milestones","href":"/api-reference/projects/create-project-milestone"},{"title":"Delete project milestone","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/projects/{id}/milestones/{milestoneId}","href":"/api-reference/projects/delete-project-milestone"},{"title":"Update project milestone","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/projects/{id}/milestones/{milestoneId}","href":"/api-reference/projects/update-project-milestone"},{"title":"Create project client action","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/client-actions","href":"/api-reference/projects/create-project-client-action"},{"title":"Delete project client action","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/projects/{id}/client-actions/{clientActionId}","href":"/api-reference/projects/delete-project-client-action"},{"title":"Update project client action","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/projects/{id}/client-actions/{clientActionId}","href":"/api-reference/projects/update-project-client-action"},{"title":"Create ticket from action item","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/client-actions/{clientActionId}/ticket","href":"/api-reference/projects/create-ticket-from-action-item"},{"title":"Create project weekly update","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/weekly-updates","href":"/api-reference/projects/create-project-weekly-update"},{"title":"Delete project weekly update","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/projects/{id}/weekly-updates/{weeklyUpdateId}","href":"/api-reference/projects/delete-project-weekly-update"},{"title":"Update project weekly update","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/projects/{id}/weekly-updates/{weeklyUpdateId}","href":"/api-reference/projects/update-project-weekly-update"},{"title":"Update project ticket status","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/tickets/status","href":"/api-reference/projects/update-project-ticket-status"},{"title":"Update project ticket owner","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/tickets/owner","href":"/api-reference/projects/update-project-ticket-owner"},{"title":"Update project ticket priority","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/tickets/priority","href":"/api-reference/projects/update-project-ticket-priority"},{"title":"Update project status","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/projects/{id}/status","href":"/api-reference/projects/update-project-status"},{"title":"List project ticket notes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/tickets/{ticketId}/notes","href":"/api-reference/projects/list-project-ticket-notes"},{"title":"Add project ticket note","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/tickets/{ticketId}/notes","href":"/api-reference/projects/add-project-ticket-note"},{"title":"Get project task controls","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/tickets/{ticketId}/controls","href":"/api-reference/projects/get-project-task-controls"},{"title":"Set project task controls","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/projects/{id}/tickets/{ticketId}/controls","href":"/api-reference/projects/set-project-task-controls"},{"title":"List project task type controls","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/task-type-controls","href":"/api-reference/projects/list-project-task-type-controls"},{"title":"Set project task type controls","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/projects/task-type-controls","href":"/api-reference/projects/set-project-task-type-controls"},{"title":"Get project display settings","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/display-settings","href":"/api-reference/projects/get-project-display-settings"},{"title":"Update project display settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/projects/display-settings","href":"/api-reference/projects/update-project-display-settings"},{"title":"List project documents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/documents","href":"/api-reference/projects/list-project-documents"},{"title":"Upload project document (inline)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/documents","href":"/api-reference/projects/upload-project-document-inline"},{"title":"Prepare direct document upload","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/documents/uploads","href":"/api-reference/projects/prepare-direct-document-upload"},{"title":"Finalize direct document upload","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/documents/uploads/{uploadId}/finalize","href":"/api-reference/projects/finalize-direct-document-upload"},{"title":"List document sharing targets","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/documents/sharing-targets","href":"/api-reference/projects/list-document-sharing-targets"},{"title":"List document versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/documents/{documentId}/versions","href":"/api-reference/projects/list-document-versions"},{"title":"Get document version download URL","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/projects/{id}/documents/{documentId}/versions/{version}/download","href":"/api-reference/projects/get-document-version-download-url"},{"title":"Restore document version","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/projects/{id}/documents/{documentId}/versions/{version}/restore","href":"/api-reference/projects/restore-document-version"},{"title":"Set document sharing","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/projects/{id}/documents/{documentId}/sharing","href":"/api-reference/projects/set-document-sharing"}]},{"group":"Backup","pages":[{"title":"Get backup summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/backup/summary","href":"/api-reference/backup/get-backup-summary"},{"title":"List backup devices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/backup/devices","href":"/api-reference/backup/list-backup-devices"},{"title":"List backup alerts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/backup/alerts","href":"/api-reference/backup/list-backup-alerts"},{"title":"List SaaS protection customers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/backup/saas-protection/customers","href":"/api-reference/backup/list-saas-protection-customers"},{"title":"Get SaaS protection customer","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/backup/saas-protection/customers/{integrationCompanyId}","href":"/api-reference/backup/get-saas-protection-customer"},{"title":"List SaaS protection seats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/backup/saas-protection/seats","href":"/api-reference/backup/list-saas-protection-seats"}]},{"group":"Microsoft 365","pages":[{"title":"List M365 licenses","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/licenses","href":"/api-reference/microsoft-365/list-m365-licenses"},{"title":"Get M365 license summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/licenses/summary","href":"/api-reference/microsoft-365/get-m365-license-summary"},{"title":"List M365 users","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/users","href":"/api-reference/microsoft-365/list-m365-users"},{"title":"List M365 domains","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/domains","href":"/api-reference/microsoft-365/list-m365-domains"},{"title":"Get Secure Score summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/secure-score/summary","href":"/api-reference/microsoft-365/get-secure-score-summary"},{"title":"Get Secure Score trend","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/secure-score/trend","href":"/api-reference/microsoft-365/get-secure-score-trend"},{"title":"List Secure Score recommendations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/m365/secure-score/recommendations","href":"/api-reference/microsoft-365/list-secure-score-recommendations"}]},{"group":"Security","pages":[{"title":"Get security summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/summary","href":"/api-reference/security/get-security-summary"},{"title":"Get DNS filtering summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/dns-filtering-summary","href":"/api-reference/security/get-dns-filtering-summary"},{"title":"Get Cloudflare zone posture","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/cloudflare-zone-posture","href":"/api-reference/security/get-cloudflare-zone-posture"},{"title":"List EDR incidents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/edr-incidents","href":"/api-reference/security/list-edr-incidents"},{"title":"List vulnerabilities","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/vulnerabilities","href":"/api-reference/security/list-vulnerabilities"},{"title":"List Huntress items","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/huntress-items","href":"/api-reference/security/list-huntress-items"},{"title":"List Avanan email threats","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/avanan-email-threats","href":"/api-reference/security/list-avanan-email-threats"},{"title":"List Bitdefender endpoints","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/bitdefender-endpoints","href":"/api-reference/security/list-bitdefender-endpoints"},{"title":"List Fortinet firewalls","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/fortinet-firewalls","href":"/api-reference/security/list-fortinet-firewalls"},{"title":"List Petra incidents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/petra-incidents","href":"/api-reference/security/list-petra-incidents"},{"title":"Get Petra identity summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/petra-identity-summary","href":"/api-reference/security/get-petra-identity-summary"},{"title":"Get security awareness summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/security/awareness-summary","href":"/api-reference/security/get-security-awareness-summary"}]},{"group":"Financial","pages":[{"title":"List quotes","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/financial/quotes","href":"/api-reference/financial/list-quotes"},{"title":"Get quote","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/financial/quotes/{id}","href":"/api-reference/financial/get-quote"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/financial/invoices","href":"/api-reference/financial/list-invoices"},{"title":"Get invoice summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/financial/invoices/summary","href":"/api-reference/financial/get-invoice-summary"},{"title":"Get invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/financial/invoices/{id}","href":"/api-reference/financial/get-invoice"},{"title":"Get revenue summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/financial/revenue-summary","href":"/api-reference/financial/get-revenue-summary"}]},{"group":"Integrations","pages":[{"title":"List integrations","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/integrations","href":"/api-reference/integrations/list-integrations"},{"title":"Get integration","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/integrations/{id}","href":"/api-reference/integrations/get-integration"},{"title":"Pause integration","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/integrations/{id}/pause","href":"/api-reference/integrations/pause-integration"},{"title":"Resume integration","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/integrations/{id}/resume","href":"/api-reference/integrations/resume-integration"}]},{"group":"Documentation","pages":[{"title":"List documentation documents","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/documentation/documents","href":"/api-reference/documentation/list-documentation-documents"},{"title":"Get documentation document","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/documentation/documents/{id}","href":"/api-reference/documentation/get-documentation-document"},{"title":"List documentation folders","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/documentation/folders","href":"/api-reference/documentation/list-documentation-folders"},{"title":"List documentation visibility roles","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/documentation/visibility-roles","href":"/api-reference/documentation/list-documentation-visibility-roles"},{"title":"Get email domain security","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/documentation/email-domain-security","href":"/api-reference/documentation/get-email-domain-security"},{"title":"Create documentation page","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/documentation/pages","href":"/api-reference/documentation/create-documentation-page"},{"title":"Update documentation page","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/documentation/pages/{id}","href":"/api-reference/documentation/update-documentation-page"},{"title":"Set documentation page visibility","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/documentation/pages/{id}/visibility","href":"/api-reference/documentation/set-documentation-page-visibility"}]},{"group":"Broadcasts","pages":[{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"List broadcast groups","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/broadcasts/groups","href":"/api-reference/broadcasts/list-broadcast-groups"},{"title":"Get broadcast","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/broadcasts/{id}","href":"/api-reference/broadcasts/get-broadcast"},{"title":"List broadcast recipients","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/broadcasts/{id}/recipients","href":"/api-reference/broadcasts/list-broadcast-recipients"}]},{"group":"Notifications","pages":[{"title":"List notifications","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/notifications","href":"/api-reference/notifications/list-notifications"},{"title":"Mark all notifications read","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/notifications/read-all","href":"/api-reference/notifications/mark-all-notifications-read"},{"title":"Set notification read state","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/notifications/{id}/read","href":"/api-reference/notifications/set-notification-read-state"}]},{"group":"Standards","pages":[{"title":"List standards","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards","href":"/api-reference/standards/list-standards"},{"title":"Create standards","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards","href":"/api-reference/standards/create-standards"},{"title":"Get company standards","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/companies/{companyId}","href":"/api-reference/standards/get-company-standards"},{"title":"Get standards compliance","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/compliance","href":"/api-reference/standards/get-standards-compliance"},{"title":"Get standard adoption","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/adoption","href":"/api-reference/standards/get-standard-adoption"},{"title":"Create standards category","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/categories","href":"/api-reference/standards/create-standards-category"},{"title":"Update standards category","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/standards/categories/{id}","href":"/api-reference/standards/update-standards-category"},{"title":"Create standard","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/items","href":"/api-reference/standards/create-standard"},{"title":"Update standard","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/standards/items/{id}","href":"/api-reference/standards/update-standard"},{"title":"Get tool stack cost","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/cost","href":"/api-reference/standards/get-tool-stack-cost"},{"title":"Get company tool stack cost","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/companies/{companyId}/cost","href":"/api-reference/standards/get-company-tool-stack-cost"},{"title":"Set standard vendor cost","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/items/{id}/cost","href":"/api-reference/standards/set-standard-vendor-cost"},{"title":"Get standards evidence","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/evidence","href":"/api-reference/standards/get-standards-evidence"},{"title":"Get standards gap analysis","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/gap-analysis","href":"/api-reference/standards/get-standards-gap-analysis"},{"title":"Get standards white space","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/white-space","href":"/api-reference/standards/get-standards-white-space"},{"title":"Get standards opportunity","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/opportunity","href":"/api-reference/standards/get-standards-opportunity"},{"title":"Link billing items to a standard","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/items/{id}/skus","href":"/api-reference/standards/link-billing-items-to-a-standard"},{"title":"Set partner price","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/partners/{partnerKey}/price","href":"/api-reference/standards/set-partner-price"},{"title":"List standards service plans","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/service-plans","href":"/api-reference/standards/list-standards-service-plans"},{"title":"Create standards service plan","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/settings/service-plans","href":"/api-reference/standards/create-standards-service-plan"},{"title":"Delete standards service plan","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/standards/settings/service-plans/{tierId}","href":"/api-reference/standards/delete-standards-service-plan"},{"title":"Update standards service plan","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/standards/settings/service-plans/{tierId}","href":"/api-reference/standards/update-standards-service-plan"},{"title":"Set service plan billing items","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/service-plans/{tierId}/skus","href":"/api-reference/standards/set-service-plan-billing-items"},{"title":"Set company type service plan","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/company-type-service-plans","href":"/api-reference/standards/set-company-type-service-plan"},{"title":"Create standard deployment option","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/settings/items/{itemId}/deployment-options","href":"/api-reference/standards/create-standard-deployment-option"},{"title":"Delete standard deployment option","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/standards/settings/deployment-options/{optionId}","href":"/api-reference/standards/delete-standard-deployment-option"},{"title":"Update standard deployment option","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/standards/settings/deployment-options/{optionId}","href":"/api-reference/standards/update-standard-deployment-option"},{"title":"Delete standards category","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/standards/settings/categories/{categoryId}","href":"/api-reference/standards/delete-standards-category"},{"title":"Delete standard","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/standards/settings/items/{itemId}","href":"/api-reference/standards/delete-standard"},{"title":"Reorder standards","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/settings/reorder","href":"/api-reference/standards/reorder-standards"},{"title":"Set standard service plans","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/items/{itemId}/service-plans","href":"/api-reference/standards/set-standard-service-plans"},{"title":"Get standard applicability catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/applicability","href":"/api-reference/standards/get-standard-applicability-catalog"},{"title":"Set standard applicability rule","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/items/{itemId}/applicability-rule","href":"/api-reference/standards/set-standard-applicability-rule"},{"title":"Get company standards applicability","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/company-applicability","href":"/api-reference/standards/get-company-standards-applicability"},{"title":"Set company standards applicability value","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/standards/settings/company-applicability","href":"/api-reference/standards/set-company-standards-applicability-value"},{"title":"Set company standard statuses","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/company-statuses","href":"/api-reference/standards/set-company-standard-statuses"},{"title":"Set company standards tracking","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/companies/{companyId}/tracking","href":"/api-reference/standards/set-company-standards-tracking"},{"title":"List billing items (agreement SKUs)","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/sku-catalog","href":"/api-reference/standards/list-billing-items-agreement-skus"},{"title":"Get standard billing links","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/items/{itemId}/sku-links","href":"/api-reference/standards/get-standard-billing-links"},{"title":"Replace standard billing links","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/items/{itemId}/sku-links","href":"/api-reference/standards/replace-standard-billing-links"},{"title":"Set billing item revenue category","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/sku-revenue-category","href":"/api-reference/standards/set-billing-item-revenue-category"},{"title":"Re-check standards billing","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/settings/billing-evaluation","href":"/api-reference/standards/re-check-standards-billing"},{"title":"Get onboarding template standard link","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/onboarding-template-tasks/{templateTaskId}/standard","href":"/api-reference/standards/get-onboarding-template-standard-link"},{"title":"Set onboarding template standard link","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/onboarding-template-tasks/{templateTaskId}/standard","href":"/api-reference/standards/set-onboarding-template-standard-link"},{"title":"List standards planner templates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/planner-templates","href":"/api-reference/standards/list-standards-planner-templates"},{"title":"Sync standards to planner","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/standards/settings/sync","href":"/api-reference/standards/sync-standards-to-planner"},{"title":"Get standards setup","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/setup","href":"/api-reference/standards/get-standards-setup"},{"title":"Update standards setup answers","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/standards/settings/setup/answers","href":"/api-reference/standards/update-standards-setup-answers"},{"title":"Search software detection keys","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/standards/settings/software","href":"/api-reference/standards/search-software-detection-keys"},{"title":"Set standard detection rules","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/standards/settings/items/{itemId}/detection-rules","href":"/api-reference/standards/set-standard-detection-rules"}]},{"group":"Customer Success","pages":[{"title":"List client health","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/client-health","href":"/api-reference/customer-success/list-client-health"},{"title":"Get client health summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/client-health/summary","href":"/api-reference/customer-success/get-client-health-summary"},{"title":"Get client health history","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/client-health/{companyId}/history","href":"/api-reference/customer-success/get-client-health-history"},{"title":"Get client benchmarks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/benchmarks","href":"/api-reference/customer-success/get-client-benchmarks"},{"title":"Get CSAT summary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/csat","href":"/api-reference/customer-success/get-csat-summary"},{"title":"List Traffic Light review","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/traffic-light","href":"/api-reference/customer-success/list-traffic-light-review"},{"title":"Search Traffic Light staff","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/traffic-light/staff","href":"/api-reference/customer-success/search-traffic-light-staff"},{"title":"Get Traffic Light status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/customer-success/traffic-light/{companyId}","href":"/api-reference/customer-success/get-traffic-light-status"},{"title":"Set Traffic Light status","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/customer-success/traffic-light/{companyId}/status","href":"/api-reference/customer-success/set-traffic-light-status"},{"title":"Set Traffic Light Purple flag","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/customer-success/traffic-light/{companyId}/purple","href":"/api-reference/customer-success/set-traffic-light-purple-flag"},{"title":"Log Traffic Light review","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/customer-success/traffic-light/{companyId}/reviews","href":"/api-reference/customer-success/log-traffic-light-review"}]},{"group":"Tasks","pages":[{"title":"List my tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tasks","href":"/api-reference/tasks/list-my-tasks"},{"title":"Add tasks","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tasks","href":"/api-reference/tasks/add-tasks"},{"title":"Delete task","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/tasks/{id}","href":"/api-reference/tasks/delete-task"},{"title":"Update task","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/tasks/{id}","href":"/api-reference/tasks/update-task"},{"title":"Complete tasks","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tasks/complete","href":"/api-reference/tasks/complete-tasks"}]},{"group":"Tenant Setup","pages":[{"title":"Get tenant setup","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tenant","href":"/api-reference/tenant-setup/get-tenant-setup"},{"title":"List primary admin candidates","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/tenant/admin-candidates","href":"/api-reference/tenant-setup/list-primary-admin-candidates"},{"title":"Update tenant profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/tenant/profile","href":"/api-reference/tenant-setup/update-tenant-profile"},{"title":"Update tenant branding","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/tenant/branding","href":"/api-reference/tenant-setup/update-tenant-branding"},{"title":"Upload branding image","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/tenant/branding/assets","href":"/api-reference/tenant-setup/upload-branding-image"},{"title":"Update tenant settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/tenant/settings","href":"/api-reference/tenant-setup/update-tenant-settings"}]},{"group":"Roles","pages":[{"title":"List roles","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/roles","href":"/api-reference/roles/list-roles"},{"title":"Create role","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/roles","href":"/api-reference/roles/create-role"},{"title":"List permission catalog","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/roles/permissions","href":"/api-reference/roles/list-permission-catalog"},{"title":"Delete role","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/public/v1/roles/{id}","href":"/api-reference/roles/delete-role"},{"title":"Update role","deprecated":null,"version":null,"openapi":"/openapi.json patch /api/public/v1/roles/{id}","href":"/api-reference/roles/update-role"},{"title":"Set default role","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/roles/{id}/default","href":"/api-reference/roles/set-default-role"},{"title":"Get role permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/roles/{id}/permissions","href":"/api-reference/roles/get-role-permissions"},{"title":"Replace role permissions","deprecated":null,"version":null,"openapi":"/openapi.json put /api/public/v1/roles/{id}/permissions","href":"/api-reference/roles/replace-role-permissions"}]},{"group":"Ticket Templates","pages":[{"title":"Create ticket template","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/ticket-templates","href":"/api-reference/ticket-templates/create-ticket-template"}]},{"group":"Readiness","pages":[{"title":"List company readiness","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/readiness","href":"/api-reference/readiness/list-company-readiness"},{"title":"Get readiness assignment options","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/readiness/assignment-options","href":"/api-reference/readiness/get-readiness-assignment-options"},{"title":"Get company readiness checks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/public/v1/readiness/{companyId}","href":"/api-reference/readiness/get-company-readiness-checks"},{"title":"Bulk update readiness","deprecated":null,"version":null,"openapi":"/openapi.json post /api/public/v1/readiness/bulk","href":"/api-reference/readiness/bulk-update-readiness"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes"}]}]},"title":"Archive planner item - MSPortal.ai Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}