If you are not already having access to a sandbox environment, please contact the Debbie team. The sandbox allows you to safely explore the API and test your integration without affecting live data.
In the Debbie platform, navigate to the Developer section in the menu on the right-hand side. From there, you can create a new API key to authenticate your requests. You can also subscribe to webhooks.
Before diving into the endpoints, we recommend reading the Core Concepts section to familiarize yourself with how Debbie works and how the different components fit together.
We’ve put together a set of practical guides covering common use cases and best practices. These will help you build a solid and effective integration.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Debbie API Documentation","colors":{"primary":"#7568F6","light":"#07C983","dark":"#7865FF"},"logo":{"light":"https://mintcdn.com/debbie-bd9dd858/c4KJPAFU082ys87I/logo/light.svg?fit=max\u0026auto=format\u0026n=c4KJPAFU082ys87I\u0026q=85\u0026s=34f2a25b0f723cac3a39f7df9c9b9dda","dark":"https://mintcdn.com/debbie-bd9dd858/c4KJPAFU082ys87I/logo/dark.svg?fit=max\u0026auto=format\u0026n=c4KJPAFU082ys87I\u0026q=85\u0026s=d98b66e4e6eed1f8e6543a2cce7f2c3c"},"favicon":"https://mintcdn.com/debbie-bd9dd858/c4KJPAFU082ys87I/favicon.png?fit=max\u0026auto=format\u0026n=c4KJPAFU082ys87I\u0026q=85\u0026s=b00359cdd2e7b84f9413747385c3c094","navbar":{"links":[{"href":"mailto:api-support@debbie.dk","label":"API Support"}],"primary":{"type":"button","label":"Developer login","href":"https://app.debbiecollect.com/developers"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/debbie"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"debbie-bd9dd858","hasAudioNarration":false,"actualSubdomain":"debbie-bd9dd858","customDomains":["documentation.debbiecollect.com"],"gitSource":{"type":"github","owner":"debbie-platform","repo":"debbie","deployBranch":"master","contentDirectory":"documentation/public-api","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0ad50d03bec028f0a57b1","collectionId":"cb01a054-1009-4387-8a77-2626444999ce","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0ad50d03bec028f0a57b1"},"entitlements":{},"buildId":"6ae0ad50d03bec028f0a57b1","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"API Reference","count":91},{"language":"default","tag":"Webhooks","count":37},{"language":"default","tag":"Customers","count":7},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"Updates","count":5},{"language":"default","tag":"Using the API","count":5},{"language":"default","tag":"API Documentation","count":4},{"language":"default","tag":"Case groups","count":4},{"language":"default","tag":"Cases","count":4},{"language":"default","tag":"End reasons","count":4}]},"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":"getting-started","slug":"/getting-started","pageMetadata":{"title":"Getting started","description":"Get started using the API","href":"/getting-started"},"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: \"Get started using the API\"\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={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Welcome! This guide will help you quickly get up and running with the Debbie API.`}),`\n`,_jsx(Heading,{level:`2`,id:`1-get-your-sandbox-environment`,children:`1. Get your sandbox environment`}),`\n`,_jsx(_components.p,{children:`If you are not already having access to a sandbox environment, please contact the Debbie team. The sandbox allows you to safely explore the API and test your integration without affecting live data.`}),`\n`,_jsx(Heading,{level:`2`,id:`2-connect-to-the-api`,children:`2. Connect to the API`}),`\n`,_jsx(_components.p,{children:`In the Debbie platform, navigate to the Developer section in the menu on the right-hand side. From there, you can create a new API key to authenticate your requests. You can also subscribe to webhooks.`}),`\n`,_jsx(Heading,{level:`2`,id:`3-understand-debbie-core-concepts`,children:`3. Understand Debbie core concepts`}),`\n`,_jsx(_components.p,{children:`Before diving into the endpoints, we recommend reading the Core Concepts section to familiarize yourself with how Debbie works and how the different components fit together.`}),`\n`,_jsx(Heading,{level:`2`,id:`4-read-our-guides`,children:`4. Read our guides`}),`\n`,_jsx(_components.p,{children:`We’ve put together a set of practical guides covering common use cases and best practices. These will help you build a solid and effective integration.`})]})}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":"Getting started","description":"Get started using the API","href":"/getting-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"1. Get your sandbox environment","slug":"1-get-your-sandbox-environment","depth":2,"children":[]},{"title":"2. Connect to the API","slug":"2-connect-to-the-api","depth":2,"children":[]},{"title":"3. Understand Debbie core concepts","slug":"3-understand-debbie-core-concepts","depth":2,"children":[]},{"title":"4. Read our guides","slug":"4-read-our-guides","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"debbie-bd9dd858","siteName":"Debbie API Documentation","title":"Getting started - Debbie API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-08-26T14:39:50.796Z","originalFileLocation":"getting-started.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=\"Get started using the API\">\u003cmeta data-mint-head name=\"application-name\" content=\"Debbie API 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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Getting started - Debbie API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get started using the API\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Debbie API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://documentation.debbiecollect.com/getting-started\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://debbie-bd9dd858.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Getting+started\u0026amp;description=Get+started+using+the+API\u0026amp;theme=568c15aea0b469fea9c832af\u0026amp;signature=5e398e5d5e5cd26a36d0f7b8cba89e630e96bc4a67f5de259096865c7225ad7b\">\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=\"Getting started - Debbie API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get started using the API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://debbie-bd9dd858.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Getting+started\u0026amp;description=Get+started+using+the+API\u0026amp;theme=568c15aea0b469fea9c832af\u0026amp;signature=5e398e5d5e5cd26a36d0f7b8cba89e630e96bc4a67f5de259096865c7225ad7b\">\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/debbie-bd9dd858/3I-wXo3P_fRaHJhV/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Debbie API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7568F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://documentation.debbiecollect.com/getting-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://documentation.debbiecollect.com/#organization\",\"name\":\"Debbie API Documentation\",\"url\":\"https://documentation.debbiecollect.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/debbie-bd9dd858/c4KJPAFU082ys87I/logo/light.svg?fit=max\u0026auto=format\u0026n=c4KJPAFU082ys87I\u0026q=85\u0026s=34f2a25b0f723cac3a39f7df9c9b9dda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://documentation.debbiecollect.com#website\",\"name\":\"Debbie API Documentation\",\"url\":\"https://documentation.debbiecollect.com\",\"publisher\":{\"@id\":\"https://documentation.debbiecollect.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://documentation.debbiecollect.com/getting-started#webpage\",\"url\":\"https://documentation.debbiecollect.com/getting-started\",\"name\":\"Getting started\",\"description\":\"Get started using the API\",\"dateModified\":\"2025-08-26T14:39:50.796Z\",\"isPartOf\":{\"@id\":\"https://documentation.debbiecollect.com#website\"},\"breadcrumb\":{\"@id\":\"https://documentation.debbiecollect.com/getting-started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://documentation.debbiecollect.com/getting-started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://documentation.debbiecollect.com/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting started\",\"item\":\"https://documentation.debbiecollect.com/getting-started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://documentation.debbiecollect.com/getting-started#article\",\"headline\":\"Getting started\",\"name\":\"Getting started\",\"description\":\"Get started using the API\",\"url\":\"https://documentation.debbiecollect.com/getting-started\",\"mainEntityOfPage\":{\"@id\":\"https://documentation.debbiecollect.com/getting-started#webpage\"},\"dateModified\":\"2025-08-26T14:39:50.796Z\",\"publisher\":{\"@id\":\"https://documentation.debbiecollect.com/#organization\"},\"isPartOf\":{\"@id\":\"https://documentation.debbiecollect.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Debbie API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Debbie API Documentation","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"tabs":[{"tab":"Using the API","groups":[{"group":"Get Started","pages":[{"title":"Introduction","description":"The Debbie API is a RESTful interface, allowing you to programmatically update, add and access your data in the platform. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses.","href":""},{"title":"Getting started","href":"/getting-started"},{"title":"Core concepts","description":"Understand core concepts in Debbie","href":"/core-concepts"}]},{"group":"Guides","pages":[{"title":"Law firm systems","icon":"scale-balanced","href":"/guides/law-firm-systems"},{"title":"Settlements","icon":"file-invoice-dollar","href":"/guides/settlements"}]}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]}]},"basePath":"","title":"Getting started - Debbie API Documentation","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":[],"chunks":[]}
