Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format Authorization: Bearer {token}. API keys are issued and revoked directly from the creditor portal under Developers > API.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Debbie Creditor API Documentation","colors":{"primary":"#7568F6","light":"#07C983","dark":"#7865FF"},"logo":{"light":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/light.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=10910a8dfb5076aec86b09686383b541","dark":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/dark.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=a44edc79d1f69627d88b16d9a5157fb9"},"favicon":"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/favicon.png?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=b296397199b185d9fb11859d70d6c74c","navbar":{"links":[{"href":"mailto:api-support@debbie.dk","label":"API Support"}]},"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-creditor-documentation","hasAudioNarration":false,"actualSubdomain":"debbie-creditor-documentation","customDomains":["creditor-documentation.debbiecollect.com"],"gitSource":{"type":"github","owner":"debbie-platform","repo":"debbie","deployBranch":"master","contentDirectory":"documentation/public-creditor-api","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af07e5a19e45f289c56f508","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":27},{"language":"default","tag":"Webhooks","count":11},{"language":"default","tag":"Using the API","count":6},{"language":"default","tag":"API Documentation","count":5},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"Get Started","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Billings","count":2},{"language":"default","tag":"Files","count":2},{"language":"default","tag":"Case voucher allocations","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":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":"rbac-expansion","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/customers/get","slug":"/api-reference/endpoints/customers/get","pageMetadata":{"title":"Get customer by id","openapi":"GET /v1/{tenantId}/customers/{customerId}","description":"Get a customer by customer id, including the users and cases related to the customer.\n\n**Required scope:** `read:customers`","href":"/api-reference/endpoints/customers/get"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Get a customer by customer id, including the users and cases related to the customer.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"read:customers\"\n })]\n })]\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}=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":"Get customer by id","openapi":"GET /v1/{tenantId}/customers/{customerId}","description":"Get a customer by customer id, including the users and cases related to the customer.\n\n**Required scope:** `read:customers`","href":"/api-reference/endpoints/customers/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Get customer by id","description":"Get a customer by customer id, including the users and cases related to the customer.\n\n**Required scope:** `read:customers`","operationId":"get-customer","parameters":["6b524f36-0f67-4807-bb49-0bb381ef7fee","295376b0-05f9-45fc-b16d-c49bc956adaf","2ad1bc9e-9692-4285-8210-a26bbee4a316"],"responses":{"200":"655fb2df-8ab0-479a-a699-b2252711bfff","401":"23fbc0f2-7a28-4d8b-8790-b94e334d0c33","404":"a0ddfea5-a3ff-46a8-aec5-0acb4d6bfcd3","422":"431ed85e-ef91-4d37-a161-a9751687b112"},"method":"get","type":"path","servers":["cc6f2f36-b7d4-4509-a86c-ea66de6298f4"],"security":["af845bea-a179-4d12-a982-b17bced29b4d"],"path":"/v1/{tenantId}/customers/{customerId}","baseUrlOptions":["https://api.debbiecollect.com"],"title":"Get customer by id","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"6b524f36-0f67-4807-bb49-0bb381ef7fee":{"in":"path","name":"tenantId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Id of your debt collection partner's tenant. You can find it on the API page in the creditor portal."},"295376b0-05f9-45fc-b16d-c49bc956adaf":{"in":"path","name":"customerId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Id of the customer","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Id of the customer"},"2ad1bc9e-9692-4285-8210-a26bbee4a316":{"in":"query","name":"creditorId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Your creditor id. You can find it on the API page in the creditor portal.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"description":"Your creditor id. You can find it on the API page in the creditor portal."}},"responses":{"655fb2df-8ab0-479a-a699-b2252711bfff":{"description":"Successful operation","content":{"application/json":{"schema":{"type":"object","properties":{"creditorId":{"type":"string","format":"uuid","description":"Id of creditor","uniqueKey":"creditorId","typeLabel":"string\u003cuuid>"},"createdAt":{"type":"string","description":"Customer created at","uniqueKey":"createdAt","typeLabel":"string"},"customerId":{"type":"string","format":"uuid","description":"Id of the customer","uniqueKey":"customerId","typeLabel":"string\u003cuuid>"},"tenantId":{"type":"string","format":"uuid","description":"Id of the tenant","uniqueKey":"tenantId","typeLabel":"string\u003cuuid>"},"referenceId":{"type":"string","description":"Reference id of the customer. Typically id of the customer, client, patient or similar.","uniqueKey":"referenceId","typeLabel":"string"},"isCompany":{"type":"boolean","description":"Whether the customer is a company.","uniqueKey":"isCompany","typeLabel":"boolean"},"users":{"type":"array","description":"List of users related to this customer","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid","description":"Id of the user","uniqueKey":"users.items.[INDEX].userId","typeLabel":"string\u003cuuid>"},"id":{"type":"number","description":"Sequential id of the user","uniqueKey":"users.items.[INDEX].id","typeLabel":"number"},"relation":{"type":"string","enum":["debtor","alternative-contact"],"description":"Type of relation to the customer","uniqueKey":"users.items.[INDEX].relation","typeLabel":"enum\u003cstring>"},"contact":{"type":"boolean","description":"Whether the user is the contact person","uniqueKey":"users.items.[INDEX].contact","typeLabel":"boolean"},"customerId":{"type":"string","format":"uuid","description":"Id of the customer","uniqueKey":"users.items.[INDEX].customerId","typeLabel":"string\u003cuuid>"},"lang":{"type":"string","enum":["bm","ba","eu","be","bn","bh","bi","bs","br","bg","my","ca","ch","ce","ny","zh","cv","kw","co","cr","hr","cs","da","dv","nl","dz","en","eo","et","ee","fo","fj","fi","fr","ff","gl","ka","de","el","gn","gu","ht","ha","he","hz","hi","ho","hu","ia","id","ie","ga","ig","ik","io","is","it","iu","ja","jv","kl","kn","kr","ks","kk","km","ki","rw","ky","kv","kg","ko","ku","kj","la","lb","lg","li","ln","lo","lt","lu","lv","gv","mk","mg","ms","ml","mt","mi","mr","mh","mn","na","nv","nd","ne","ng","nb","nn","no","ii","nr","oc","oj","cu","om","or","os","pa","pi","fa","pl","ps","pt","qu","rm","rn","ro","ru","sa","sc","sd","se","sm","sg","sr","gd","sn","si","sk","sl","so","st","es","su","sw","ss","sv","ta","te","tg","th","ti","bo","tk","tl","tn","to","tr","ts","tt","tw","ty","ug","uk","ur","uz","ve","vi","vo","wa","cy","wo","fy","xh","yi","yo","za","zu"],"description":"The language of the user","uniqueKey":"users.items.[INDEX].lang","typeLabel":"enum\u003cstring>"},"details":{"type":"object","properties":{"name":{"type":"string","description":"Name of the user","uniqueKey":"users.items.[INDEX].details.name","typeLabel":"string"},"cpr":{"type":"string","description":"The cpr number of a user, only used when user is a person.","uniqueKey":"users.items.[INDEX].details.cpr","typeLabel":"string"},"cvr":{"type":"string","description":"The cvr number of a user, only used when user is a company.","uniqueKey":"users.items.[INDEX].details.cvr","typeLabel":"string"},"email":{"type":"string","description":"The email of the user","uniqueKey":"users.items.[INDEX].details.email","typeLabel":"string"},"phone":{"type":"object","description":"The users' phone number with locale","properties":{"number":{"type":"string","description":"The users' phone number. For example 12345678.","uniqueKey":"users.items.[INDEX].details.phone.number","typeLabel":"string"},"locale":{"type":"string","description":"The users' phone locale. For example 45.","uniqueKey":"users.items.[INDEX].details.phone.locale","typeLabel":"string"}},"uniqueKey":"users.items.[INDEX].details.phone","typeLabel":"object"},"address":{"type":"object","properties":{"address":{"type":"string","description":"The street name and number of the address","isRequired":true,"uniqueKey":"users.items.[INDEX].details.address.address","typeLabel":"string"},"zipcode":{"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].details.address.zipcode","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"users.items.[INDEX].details.address.city","typeLabel":"string"},"coAddress":{"type":"string","uniqueKey":"users.items.[INDEX].details.address.coAddress","typeLabel":"string"},"country":{"type":"string","uniqueKey":"users.items.[INDEX].details.address.country","typeLabel":"string"}},"required":["address","zipcode","city"],"description":"The debtors address","uniqueKey":"users.items.[INDEX].details.address","typeLabel":"object"},"geocode":{"type":"object","properties":{"latitude":{"type":"number","uniqueKey":"users.items.[INDEX].details.geocode.latitude","typeLabel":"number"},"longitude":{"type":"number","uniqueKey":"users.items.[INDEX].details.geocode.longitude","typeLabel":"number"}},"uniqueKey":"users.items.[INDEX].details.geocode","typeLabel":"object"}},"uniqueKey":"users.items.[INDEX].details","typeLabel":"object"}},"uniqueKey":"users.items.[INDEX]","typeLabel":"object"},"uniqueKey":"users","typeLabel":"object[]"},"cases":{"type":"array","description":"List of cases related to this customer","items":{"type":"object","properties":{"caseId":{"type":"string","format":"uuid","description":"Id of the case","uniqueKey":"cases.items.[INDEX].caseId","typeLabel":"string\u003cuuid>"},"id":{"type":"number","description":"Sequential id of the case","uniqueKey":"cases.items.[INDEX].id","typeLabel":"number"},"status":{"type":"string","enum":["PENDING","VERIFIED","ENDED"],"description":"Status of the case","uniqueKey":"cases.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"endReason":{"type":"string","enum":["PAID","OVERPAYMENT","PARTIALLY_PAID","DEAD","BANKRUPTCY","OBJECTION","ERROR_CREDITOR","ERROR_US","WITHDRAWN","EXPIRATION","IRRECOVERABLE","TRANSFERRED","NO_COURT","UNIDENTIFIED","OFFER_FROM_US","OFFER_FROM_DEBTOR","FORCED_DISSOLVED","NEGATIVE_PAYOFF","DEPARTED","CREDITOR_UNRESPONSIVE","MERGED","FIRE_AND_FORGET","SMALL_CASE_NOT_WANTED","ADDRESS_UNKNOWN","DEBT_RELIEF","CONFLICT_OF_INTEREST","MINOR","DELETED","NO_DEBT"],"description":"Reason why the case is ended","uniqueKey":"cases.items.[INDEX].endReason","typeLabel":"enum\u003cstring>"},"statusTime":{"type":"string","description":"Case status changed at","uniqueKey":"cases.items.[INDEX].statusTime","typeLabel":"string"},"createdAt":{"type":"string","description":"Case created at","uniqueKey":"cases.items.[INDEX].createdAt","typeLabel":"string"}},"uniqueKey":"cases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cases","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"customerId":"268b30d2-e895-42b9-8a38-2451a87e19b2","creditorId":"a7fcf07c-74f2-40d9-8ea6-e67b07b14ca4","isCompany":false,"referenceId":"123","createdAt":"2024-04-19T07:30:21.070Z","users":[{"contact":true,"lang":"da","relation":"debtor","details":{"name":"Hans Hansen","email":"example@debbie.dk","phone":{"locale":"45","number":"12345678"},"address":{"address":"Applebys Plads 7, 1.","coAddress":null,"city":"København K","zipcode":"1411","country":"Danmark"}}}],"cases":[{"caseId":"268b30d2-e895-42b9-8a38-2451a87e19b2","id":123456,"status":"VERIFIED","endReason":null,"statusTime":"2024-04-19T07:30:21.070Z","createdAt":"2024-04-19T07:30:21.070Z"}]},"examples":{"Example":{"title":"Example","value":{"customerId":"268b30d2-e895-42b9-8a38-2451a87e19b2","creditorId":"a7fcf07c-74f2-40d9-8ea6-e67b07b14ca4","isCompany":false,"referenceId":"123","createdAt":"2024-04-19T07:30:21.070Z","users":[{"contact":true,"lang":"da","relation":"debtor","details":{"name":"Hans Hansen","email":"example@debbie.dk","phone":{"locale":"45","number":"12345678"},"address":{"address":"Applebys Plads 7, 1.","coAddress":null,"city":"København K","zipcode":"1411","country":"Danmark"}}}],"cases":[{"caseId":"268b30d2-e895-42b9-8a38-2451a87e19b2","id":123456,"status":"VERIFIED","endReason":null,"statusTime":"2024-04-19T07:30:21.070Z","createdAt":"2024-04-19T07:30:21.070Z"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"23fbc0f2-7a28-4d8b-8790-b94e334d0c33":{"description":"Access token missing or invalid","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"a0ddfea5-a3ff-46a8-aec5-0acb4d6bfcd3":{"description":"The requested resource was not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"431ed85e-ef91-4d37-a161-a9751687b112":{"description":"Unable to process the contained instructions.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"af845bea-a179-4d12-a982-b17bced29b4d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"cc6f2f36-b7d4-4509-a86c-ea66de6298f4":{"url":"https://api.debbiecollect.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authentication with an API key can be done by using a bearer token in the Authorization header. This is done using the following format `Authorization: Bearer {token}`. API keys are issued and revoked directly from the creditor portal under Developers > API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"debbie-creditor-documentation","siteName":"Debbie Creditor API Documentation","title":"Get customer by id - Debbie Creditor API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-30T19:46:29.551Z","originalFileLocation":"api-reference/endpoints/customers/get.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 a customer by customer id, including the users and cases related to the customer. Required scope: read:customers\">\u003cmeta data-mint-head name=\"application-name\" content=\"Debbie Creditor 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-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/debbie-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_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-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get customer by id - Debbie Creditor API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a customer by customer id, including the users and cases related to the customer. Required scope: read:customers\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://debbie-creditor-documentation.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+customer+by+id\u0026amp;description=Get+a+customer+by+customer+id%2C+including+the+users+and+cases+related+to+the+customer.%0A%0A**Required+scope%3A**+%60read%3Acustomers%60\u0026amp;theme=6e81307c9eeccd10d2f7bdff\u0026amp;signature=8d4d2e5d08c0e4df38e641b1311d0c7124d578ac842eb2b098bb3849b2ad101a\">\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=\"Get customer by id - Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a customer by customer id, including the users and cases related to the customer. Required scope: read:customers\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://debbie-creditor-documentation.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Get+customer+by+id\u0026amp;description=Get+a+customer+by+customer+id%2C+including+the+users+and+cases+related+to+the+customer.%0A%0A**Required+scope%3A**+%60read%3Acustomers%60\u0026amp;theme=6e81307c9eeccd10d2f7bdff\u0026amp;signature=8d4d2e5d08c0e4df38e641b1311d0c7124d578ac842eb2b098bb3849b2ad101a\">\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-creditor-documentation/LIPdFlzLnkfMvdFW/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Debbie Creditor API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7568F6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/customers/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\",\"name\":\"Debbie Creditor API Documentation\",\"url\":\"https://creditor-documentation.debbiecollect.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/debbie-creditor-documentation/kIVe9zqPb7fl-T8E/logo/light.svg?fit=max\u0026auto=format\u0026n=kIVe9zqPb7fl-T8E\u0026q=85\u0026s=10910a8dfb5076aec86b09686383b541\"}},{\"@type\":\"WebSite\",\"@id\":\"https://creditor-documentation.debbiecollect.com#website\",\"name\":\"Debbie Creditor API Documentation\",\"url\":\"https://creditor-documentation.debbiecollect.com\",\"publisher\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get#webpage\",\"url\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get\",\"name\":\"Get customer by id\",\"description\":\"Get a customer by customer id, including the users and cases related to the customer. Required scope: read:customers\",\"dateModified\":\"2026-08-30T19:46:29.551Z\",\"isPartOf\":{\"@id\":\"https://creditor-documentation.debbiecollect.com#website\"},\"breadcrumb\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customers\",\"item\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get customer by id\",\"item\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get#apireference\",\"headline\":\"Get customer by id\",\"name\":\"Get customer by id\",\"description\":\"Get a customer by customer id, including the users and cases related to the customer. Required scope: read:customers\",\"url\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get\",\"mainEntityOfPage\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/api-reference/endpoints/customers/get#webpage\"},\"dateModified\":\"2026-08-30T19:46:29.551Z\",\"publisher\":{\"@id\":\"https://creditor-documentation.debbiecollect.com/#organization\"},\"isPartOf\":{\"@id\":\"https://creditor-documentation.debbiecollect.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Debbie Creditor API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Debbie Creditor API Documentation","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"chart-network","href":"https://debbie.checkly-status-page.com"}]},"tabs":[{"tab":"Using the API","pages":[{"title":"Using the API","href":""}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Pagination","href":"/api-reference/pagination"},{"title":"Idempotency","href":"/api-reference/idempotency"},{"title":"Voucher types","href":"/api-reference/voucher-types"}]},{"group":"Customers","pages":[{"title":"Create customer","openapi":"POST /v1/{tenantId}/customers","description":"Create a new customer under your creditor. A customer represents your end-customer relationship and holds the contact details of the debtor.\n\n**Required scope:** `write:customers`","href":"/api-reference/endpoints/customers/create"},{"title":"Get customer by id","openapi":"GET /v1/{tenantId}/customers/{customerId}","href":"/api-reference/endpoints/customers/get"},{"title":"Get customer by reference id","openapi":"GET /v1/{tenantId}/customers/by-reference-id/{referenceId}","description":"Get a customer by your own reference id, including the users and cases related to the customer.\n\n**Required scope:** `read:customers`","href":"/api-reference/endpoints/customers/get-by-reference"},{"title":"Add case vouchers","openapi":"POST /v1/{tenantId}/customers/{customerId}/add-case-vouchers","href":"/api-reference/endpoints/customers/add-case-vouchers"}]},{"group":"Case voucher allocations","pages":[{"title":"Register case voucher allocation","openapi":"POST /v1/{tenantId}/case-vouchers/allocations","href":"/api-reference/endpoints/case-vouchers/allocations"}]},{"group":"Files","pages":[{"title":"Upload file","openapi":"POST /v1/{tenantId}/files","href":"/api-reference/endpoints/files/create"},{"title":"Get file","openapi":"GET /v1/{tenantId}/files/{fileId}/{fileName}","href":"/api-reference/endpoints/files/get"}]},{"group":"Documents","pages":[{"title":"Add document","openapi":"POST /v1/{tenantId}/documents","href":"/api-reference/endpoints/documents/create"}]},{"group":"Voucher types","pages":[{"title":"Get voucher types","openapi":"GET /v1/{tenantId}/voucher-types","href":"/api-reference/endpoints/voucher-types/get"}]},{"group":"Billings","pages":[{"title":"Get deposit distribution","openapi":"GET /v1/{tenantId}/billings/{billingId}/deposit-distribution","href":"/api-reference/endpoints/billings/deposit-distribution"},{"title":"Get billing vouchers","openapi":"GET /v1/{tenantId}/billings/{billingId}/billing-vouchers","href":"/api-reference/endpoints/billings/billing-vouchers"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks/introduction"},{"title":"Create webhook","openapi":"POST /v1/{tenantId}/webhooks","href":"/api-reference/endpoints/webhooks/create"},{"title":"Get webhooks","openapi":"GET /v1/{tenantId}/webhooks","href":"/api-reference/endpoints/webhooks/get-list"},{"title":"Get webhook","openapi":"GET /v1/{tenantId}/webhooks/{webhookId}","href":"/api-reference/endpoints/webhooks/get"},{"title":"Delete webhook","openapi":"DELETE /v1/{tenantId}/webhooks/{webhookId}","href":"/api-reference/endpoints/webhooks/delete"},{"title":"Get webhook items","openapi":"GET /v1/{tenantId}/webhooks/items","href":"/api-reference/endpoints/webhooks/get-items"},{"title":"Patch webhook item","openapi":"PATCH /v1/{tenantId}/webhooks/items/{itemId}","href":"/api-reference/endpoints/webhooks/patch-item"},{"title":"Case created","openapi":"webhook cases.create","href":"/api-reference/webhooks/cases.create"},{"title":"Case updated","openapi":"webhook cases.update","href":"/api-reference/webhooks/cases.update"},{"title":"Case deleted","openapi":"webhook cases.delete","href":"/api-reference/webhooks/cases.delete"},{"title":"Billing created","openapi":"webhook billings.create","href":"/api-reference/webhooks/billings.create"}]}]}]},"basePath":"","title":"Get customer by id - Debbie Creditor API Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}