Pland is a next-generation operation system for facility management which is highly customisable, incredibly powerful and data-driven. In these guides, you can find everything you need to build powerful integrations, automations and data pipelines on top of Pland.Our docs cover guides, examples, references and code to help you build apps and workflows.The Pland Developer Platform consists of two parts:
API Reference
Build applications that interact with Pland workspaces programmatically.
Guides (coming soon)
Learn to interact with the Pland API by following pre-build workflows.
If you have any questions or feedback, send us an email to support@pland.app.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Pland Developer Platform","colors":{"primary":"#2563EB","light":"#bfdbfe","dark":"#1E40AF"},"logo":{"light":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-light.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=58e21d630b18eebde27bee10fa752eb3","dark":"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=426b8f2e17759f6cab27a2049c396092"},"favicon":"/favicon.png","navbar":{"links":[{"label":"Support","href":"mailto:support@pland.app"}],"primary":{"type":"button","label":"Dashboard","href":"https://cloud.pland.app/login"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/pland-software","youtube":"https://www.youtube.com/@pland.software"}},"seo":{"indexing":"navigable"},"icons":{"library":"fontawesome"},"navigation":{"global":{"anchors":[{"anchor":"Roadmap","icon":"road","href":"https://feedback.pland.app/de/roadmap/main"},{"anchor":"Changelog","icon":"bullhorn","href":"https://feedback.pland.app/de/changelog"},{"anchor":"Knowledge Base","icon":"book","href":"https://help.pland.app"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"pland","hasAudioNarration":false,"actualSubdomain":"pland","customDomains":["docs.pland.app"],"gitSource":{"type":"gitlab","owner":"common-digital","repo":"pland-docs","projectId":71427967,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e72d094e7057e3148df0","collectionId":"72c63d0c-dc7f-4b3f-8b62-95a30f93a70b","schemaVersion":"v2"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6a21e72d094e7057e3148df0:success","clientVersion":"0.0.3902","searchFilterCounts":[{"language":"default","tag":"API Reference","count":80},{"language":"default","tag":"Users","count":8},{"language":"default","tag":"Documents","count":7},{"language":"default","tag":"Customers","count":6},{"language":"default","tag":"Objects","count":6},{"language":"default","tag":"Tasks","count":6},{"language":"default","tag":"Absences","count":5},{"language":"default","tag":"Articles","count":5},{"language":"default","tag":"Equipment","count":5},{"language":"default","tag":"Quality Control","count":5}]},"assistantConfig":{},"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":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2-autocommit","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-branches-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"teamspace","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"client-snapshot-docs-config","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"stylse.css","content":".nav-tabs-item:nth-child(3)::after{content:\"Coming soon\";display:inline-block;font-size:.65rem;font-weight:700;line-height:1.25;padding:.125rem .25rem;margin-left:.5rem;border-radius:var(--rounded-md, .375rem);background-color:rgb(var(--primary)/.1)}html.light .nav-tabs-item:nth-child(3)::after{color:rgb(var(--primary-dark))}html.dark .nav-tabs-item:nth-child(3)::after{color:rgb(var(--primary-light))}"}],"page":{"pagePath":"index","slug":"/","pageMetadata":{"title":"Welcome","description":"Start building with the Pland Developer Platform","href":"/index"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Start building with the Pland Developer Platform\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Card,CardGroup,OptimizedImage}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Pland is a next-generation operation system for facility management which is highly customisable, incredibly powerful and data-driven. In these guides, you can find everything you need to build powerful integrations, automations and data pipelines on top of Pland.`}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=e905abf2a8fbc8f23790034e6bed54dc`,alt:`Hero`,style:{borderRadius:`8px`},\"data-og-width\":`2352`,width:`2352`,\"data-og-height\":`816`,height:`816`,\"data-path\":`images/hero.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?w=280\u0026fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=2ab26764b398268eab1387a078d59ae1 280w, https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?w=560\u0026fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=5dff172a7a7a9ebecc8259010d050caf 560w, https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?w=840\u0026fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=8dc6c02ba1d3fd4843f53bec1ff7e5ad 840w, https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?w=1100\u0026fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=ab67822c28f03b5826ac055228e96ee2 1100w, https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?w=1650\u0026fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=5923cf69277a845972e35a747bcd05cb 1650w, https://mintcdn.com/pland/4nF818XuJvdH1X-y/images/hero.png?w=2500\u0026fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=5ca907e671c2736dccdb267187e46830 2500w`}),`\n`,_jsx(_components.p,{children:`Our docs cover guides, examples, references and code to help you build apps and workflows.`}),`\n`,_jsx(_components.p,{children:`The Pland Developer Platform consists of two parts:`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`API Reference`,icon:`server`,href:`https://docs.pland.app/api-reference/`,children:_jsx(_components.p,{children:`Build applications that interact with Pland workspaces programmatically.`})}),_jsx(Card,{title:`Guides (coming soon)`,icon:`code`,iconType:`solid`,children:_jsx(_components.p,{children:`Learn to interact with the Pland API by following pre-build workflows.`})})]}),`\n`,_jsxs(_components.p,{children:[`If you have any questions or feedback, send us an email to `,_jsx(_components.a,{href:`mailto:support@pland.app`,children:`support@pland.app`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Welcome","description":"Start building with the Pland Developer Platform","href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"pland","siteName":"Pland Developer Platform","title":"Welcome - Pland Developer Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-13T17:52:01.857Z","originalFileLocation":"index.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=\"Start building with the Pland Developer Platform\">\u003cmeta data-mint-head name=\"application-name\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_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/pland/T_oVkU3Prt9hFyNK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Welcome - Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Start building with the Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.pland.app\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Welcome - Pland Developer Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Start building with the Pland Developer Platform\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/pland/T_oVkU3Prt9hFyNK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Pland Developer Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.pland.app\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.pland.app/#organization\",\"name\":\"Pland Developer Platform\",\"url\":\"https://docs.pland.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/pland/4nF818XuJvdH1X-y/logo/logo-light.png?fit=max\u0026auto=format\u0026n=4nF818XuJvdH1X-y\u0026q=85\u0026s=58e21d630b18eebde27bee10fa752eb3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.pland.app#website\",\"name\":\"Pland Developer Platform\",\"url\":\"https://docs.pland.app\",\"publisher\":{\"@id\":\"https://docs.pland.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.pland.app/#webpage\",\"url\":\"https://docs.pland.app/\",\"name\":\"Welcome\",\"description\":\"Start building with the Pland Developer Platform\",\"dateModified\":\"2025-11-13T17:52:01.857Z\",\"isPartOf\":{\"@id\":\"https://docs.pland.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.pland.app/#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.pland.app/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get started\",\"item\":\"https://docs.pland.app/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Welcome\",\"item\":\"https://docs.pland.app/\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.pland.app/#article\",\"headline\":\"Welcome\",\"name\":\"Welcome\",\"description\":\"Start building with the Pland Developer Platform\",\"url\":\"https://docs.pland.app/\",\"mainEntityOfPage\":{\"@id\":\"https://docs.pland.app/#webpage\"},\"dateModified\":\"2025-11-13T17:52:01.857Z\",\"publisher\":{\"@id\":\"https://docs.pland.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.pland.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Pland Developer Platform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Pland Developer Platform","nav":{"global":{"anchors":[{"anchor":"Roadmap","icon":"road","href":"https://feedback.pland.app/de/roadmap/main"},{"anchor":"Changelog","icon":"bullhorn","href":"https://feedback.pland.app/de/changelog"},{"anchor":"Knowledge Base","icon":"book","href":"https://help.pland.app"}]},"tabs":[{"tab":"Introduction","hidden":false,"groups":[{"group":"Get started","pages":[{"title":"Welcome","href":""}]},{"group":"Core concepts","tag":"Coming soon","pages":[{"title":"Users and workspaces","href":"/introduction/core-concepts/users-and-workspaces"},{"title":"Core entities","href":"/introduction/core-concepts/core-entities"}]}]},{"tab":"API Reference","hidden":false,"pages":[{"title":"API Reference","href":"/api-reference/getting-started/authentication"}]},{"tab":"Guides"}]},"title":"Welcome - Pland Developer Platform","buildId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","deploymentId":"dpl_C3fsfi1EcrBns9Vx91gUSN1X3Hi4","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-Evwtz42K.js","PlusIcon-DYlJbUaT.js","lightbox-handle-r17bVUz3.js"]}