All API endpoints require authentication using an API key. You must include your API key in the Authorization header of each request using the Bearer token format.
Client keys are restricted to client context and dont have access to some endpoints.We highlight restricted endpoints in our API reference:
This endpoint is only available with an Accountant API key.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Steuerboard Documentation","colors":{"primary":"#000000","light":"#FFFFFF","dark":"#000000"},"logo":{"light":"https://mintcdn.com/steuerboard/sB7_s40Sq_T5gFxW/logo/light.svg?fit=max\u0026auto=format\u0026n=sB7_s40Sq_T5gFxW\u0026q=85\u0026s=6737ea02eb7340982ba14b58ccecef20","dark":"https://mintcdn.com/steuerboard/sB7_s40Sq_T5gFxW/logo/dark.svg?fit=max\u0026auto=format\u0026n=sB7_s40Sq_T5gFxW\u0026q=85\u0026s=0e47c431aa47ad1991bd18345ae1c899"},"favicon":"/favicon.ico","background":{"decoration":"windows"},"navbar":{"links":[{"href":"mailto:support@steuerboard.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.steuerboard.com"}},"footer":{"socials":{"github":"https://github.com/steuerboard","linkedin":"https://www.linkedin.com/company/steuerboard-com"}},"icons":{"library":"lucide"},"integrations":{"posthog":{"apiKey":"phc_KhTnF0DD0AqM2H5Xv2oXTT7w2bJUHw3tIUR5EpHG6ov"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://steuerboard.com"},{"anchor":"Help Center","icon":"info","href":"https://help.steuerboard.com"},{"anchor":"Blog","icon":"newspaper","href":"https://steuerboard.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"steuerboard","hasAudioNarration":false,"actualSubdomain":"steuerboard","customDomains":["docs.steuerboard.com"],"gitSource":{"type":"github","owner":"steuerboard","repo":"steuerboard-monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e7bf03d4026a3ef7953e","collectionId":"6cb11d9c-e353-4f02-a258-b7af496a1e56","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e7bf03d4026a3ef7953e:success","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Reference","count":47},{"language":"default","tag":"files","count":6},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"admin.users","count":5},{"language":"default","tag":"tasks","count":5},{"language":"default","tag":"users","count":5},{"language":"default","tag":"Guides","count":4},{"language":"default","tag":"admin.clients","count":4},{"language":"default","tag":"workspaces","count":4},{"language":"default","tag":"workspace.members","count":3}]},"assistantConfig":{},"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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-keys","slug":"/api-keys","pageMetadata":{"title":"API Keys","description":"How to get your API Key","icon":"key","href":"/api-keys","hidden":false},"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: \"How to get your API Key\"\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`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`All API endpoints require authentication using an API key. You must include your API key in the Authorization header of each request using the Bearer token format.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-an-api-key-takes-under-a-minute`,children:`Getting an API Key (takes under a minute)`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Login into your account at app.steuerboard.com`}),`\n`,_jsxs(_components.li,{children:[`Go to the API page: `,_jsx(_components.strong,{children:`Settings -> API`})]}),`\n`,_jsx(_components.li,{children:`Create a new API key`}),`\n`]}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Don’t have an account?`})}),`\n`,_jsxs(Note,{children:[`We offer a free plan for testing. Just mail us at `,_jsx(_components.a,{href:`mailto:founders@steuerboard.com`,children:`founders@steuerboard.com`})]}),`\n`,_jsxs(_components.p,{children:[`If you want to use our App in production, please take a look at our `,_jsx(_components.a,{href:`https://steuerboard.com/pricing`,children:`Pricing page`}),` to book a call with us.`]}),`\n`,_jsx(Heading,{level:`2`,id:`types-of-keys`,children:`Types of keys`}),`\n`,_jsx(_components.p,{children:`There are two types of API keys:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Accountant keys`}),`\n`,_jsx(_components.li,{children:`Client keys`}),`\n`]}),`\n`,_jsx(_components.p,{children:`Client keys are restricted to client context and dont have access to some endpoints.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`We highlight restricted endpoints in our API reference:`})}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`This endpoint is only available with an `,_jsx(_components.strong,{children:`Accountant API key`}),`.`]})})]})}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":"API Keys","description":"How to get your API Key","icon":"key","href":"/api-keys","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting an API Key (takes under a minute)","slug":"getting-an-api-key-takes-under-a-minute","depth":2,"children":[]},{"title":"Types of keys","slug":"types-of-keys","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"steuerboard","siteName":"Steuerboard Documentation","title":"API Keys - Steuerboard Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-25T23:02:52.032Z","originalFileLocation":"api-keys.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=\"How to get your API Key\">\u003cmeta data-mint-head name=\"application-name\" content=\"Steuerboard 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/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_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/steuerboard/H3WvTNgsRMZSDuAj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Keys - Steuerboard Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"How to get your API Key\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Steuerboard Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.steuerboard.com/api-keys\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://steuerboard.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=API+Keys\u0026amp;description=How+to+get+your+API+Key\u0026amp;theme=bd2790e1e237196d7ab42cb4\u0026amp;signature=ab9e8058b9f8397798e169f7b8cff3005333b6ba5e702e0e17db93e126f57bbb\">\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=\"API Keys - Steuerboard Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"How to get your API Key\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://steuerboard.mintlify.app/_mintlify/api/og/v2?division=Getting+started\u0026amp;title=API+Keys\u0026amp;description=How+to+get+your+API+Key\u0026amp;theme=bd2790e1e237196d7ab42cb4\u0026amp;signature=ab9e8058b9f8397798e169f7b8cff3005333b6ba5e702e0e17db93e126f57bbb\">\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/steuerboard/H3WvTNgsRMZSDuAj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Steuerboard Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.steuerboard.com/api-keys\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-keys.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.steuerboard.com/#organization\",\"name\":\"Steuerboard Documentation\",\"url\":\"https://docs.steuerboard.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/steuerboard/sB7_s40Sq_T5gFxW/logo/light.svg?fit=max\u0026auto=format\u0026n=sB7_s40Sq_T5gFxW\u0026q=85\u0026s=6737ea02eb7340982ba14b58ccecef20\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.steuerboard.com#website\",\"name\":\"Steuerboard Documentation\",\"url\":\"https://docs.steuerboard.com\",\"publisher\":{\"@id\":\"https://docs.steuerboard.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.steuerboard.com/api-keys#webpage\",\"url\":\"https://docs.steuerboard.com/api-keys\",\"name\":\"API Keys\",\"description\":\"How to get your API Key\",\"dateModified\":\"2026-01-25T23:02:52.032Z\",\"isPartOf\":{\"@id\":\"https://docs.steuerboard.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.steuerboard.com/api-keys#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.steuerboard.com/api-keys#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting started\",\"item\":\"https://docs.steuerboard.com/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Keys\",\"item\":\"https://docs.steuerboard.com/api-keys\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.steuerboard.com/api-keys#article\",\"headline\":\"API Keys\",\"name\":\"API Keys\",\"description\":\"How to get your API Key\",\"url\":\"https://docs.steuerboard.com/api-keys\",\"mainEntityOfPage\":{\"@id\":\"https://docs.steuerboard.com/api-keys#webpage\"},\"dateModified\":\"2026-01-25T23:02:52.032Z\",\"publisher\":{\"@id\":\"https://docs.steuerboard.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.steuerboard.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Steuerboard Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Steuerboard Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://steuerboard.com"},{"anchor":"Help Center","icon":"info","href":"https://help.steuerboard.com"},{"anchor":"Blog","icon":"newspaper","href":"https://steuerboard.com/blog"}]},"tabs":[{"tab":"Guides","groups":[{"group":"Getting started","pages":[{"title":"Introduction","description":"Welcome to the Steuerboard Documentation","icon":"book-open","href":""},{"title":"API Keys","icon":"key","href":"/api-keys"}]},{"group":"Integrations","pages":[{"title":"MCP server","description":"Integrate the Steuerboard API into your AI assistant","icon":"audio-waveform","href":"/integrations/mcp"},{"title":"n8n","icon":"git-fork","href":"/integrations/n8n"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"API Keys - Steuerboard Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}
