Retrieves a single deal, including its CRM identifiers and, when available, its AI-generated summary. When returnAiFields is set, the response also includes the value of each AI field of the workspace for this deal; fields without a generated value have state Missing.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Claap API","description":"Claap API documentation","colors":{"primary":"#FF5A81","light":"#FF5A81","dark":"#FF5A81"},"logo":{"light":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda","dark":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda"},"favicon":"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/favicon.ico?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=5364cc1bba934c12994999c57de9f134","navbar":{"links":[{"href":"https://help.claap.io","label":"Claap Help Center"},{"href":"mailto:support@claap.io","label":"Support"},{"href":"https://www.claap.io/contact","label":"Book a demo"}]},"footer":{"socials":{"website":"https://claap.io","linkedin":"https://www.linkedin.com/company/claap-io","slack":"https://join.slack.com/t/firstclaapers/shared_invite/zt-qtel9fc0-sSyLA9M2higrtd4nwF6Hcw","x":"https://twitter.com/claap_io","youtube":"https://www.youtube.com/@claap_io"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"claap","hasAudioNarration":false,"actualSubdomain":"claap","customDomains":["docs.claap.io"],"gitSource":{"type":"github","owner":"claap-app","repo":"api-documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb0e66ee97d2ce49edde83","collectionId":"774daf7f-2957-47c8-8b32-8333d9903d77","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb0e66ee97d2ce49edde83"},"entitlements":{},"buildId":"6adb0e66ee97d2ce49edde83","clientVersion":"0.0.3964","searchFilterCounts":[{"language":"default","tag":"API reference","count":96},{"language":"default","tag":"Recording","count":22},{"language":"default","tag":"Deal","count":21},{"language":"default","tag":"Company","count":14},{"language":"default","tag":"Contact","count":11},{"language":"default","tag":"Getting started","count":8},{"language":"default","tag":"Admin automation","count":5},{"language":"default","tag":"Folder","count":4},{"language":"default","tag":"Invite","count":4},{"language":"default","tag":"User group","count":4}]},"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":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","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":"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":[],"page":{"pagePath":"api-reference/endpoint/get_deal","slug":"/api-reference/endpoint/get_deal","pageMetadata":{"title":"Get deal details","openapi":"GET /v1/deals/{dealId}","description":"Retrieve a deal.","href":"/api-reference/endpoint/get_deal"},"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: \"Retrieve a deal.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_components.p,{children:[`Retrieves a single deal, including its CRM identifiers and, when available, its AI-generated summary. When `,_jsx(_components.code,{children:`returnAiFields`}),` is set, the response also includes the value of each AI field of the workspace for this deal; fields without a generated value have state `,_jsx(_components.code,{children:`Missing`}),`.`]})}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 deal details","openapi":"GET /v1/deals/{dealId}","description":"Retrieve a deal.","href":"/api-reference/endpoint/get_deal"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"200":"b2e8f688-476c-443b-bce2-49e2be4f57fe","404":"7b236799-41c1-4f60-804f-7e95170fc058"},"operationId":"getV1DealsByDealId","parameters":["709ddd72-9885-42f9-9923-d589b48f0a61","3cb1f7b4-7045-441a-bf35-0123b3444e68"],"description":"Retrieve a deal.","method":"get","type":"path","servers":["8ee810c4-540f-441a-9f25-6055c9139c4c"],"security":["9666b11d-87f1-4fa8-8ecb-a775921bac48"],"path":"/v1/deals/{dealId}","baseUrlOptions":["https://api.claap.io/"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"709ddd72-9885-42f9-9923-d589b48f0a61":{"in":"path","name":"dealId","schema":{"type":"string","description":"Deal identifier","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true},"3cb1f7b4-7045-441a-bf35-0123b3444e68":{"in":"query","name":"returnAiFields","schema":{"type":"string","enum":["true","1","false","0"],"default":"false","description":"If set to true, fill the `aiFields` attribute with the AI field values of the deal.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"responses":{"b2e8f688-476c-443b-bce2-49e2be4f57fe":{"description":"Deal was successfully retrieved","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"object","properties":{"deal":{"type":"object","properties":{"dealId":{"type":"string","description":"The deal identifier.","isRequired":true,"uniqueKey":"result.deal.dealId","typeLabel":"string"},"companyIds":{"type":"array","items":{"type":"string","uniqueKey":"result.deal.companyIds.items.[INDEX]","typeLabel":"string"},"description":"The identifiers of the companies associated with the deal.","isRequired":true,"uniqueKey":"result.deal.companyIds","typeLabel":"string[]"},"contactIds":{"type":"array","items":{"type":"string","uniqueKey":"result.deal.contactIds.items.[INDEX]","typeLabel":"string"},"description":"The identifiers of the contacts associated with the deal.","isRequired":true,"uniqueKey":"result.deal.contactIds","typeLabel":"string[]"},"openedAt":{"type":"string","description":"The deal creation date (ISO datetime).","isRequired":true,"uniqueKey":"result.deal.openedAt","typeLabel":"string"},"source":{"oneOf":[{"type":"object","description":"The CRM the deal originates from, and its identifiers in that CRM.","required":["kind","attioId","attioWorkspaceId"],"properties":{"kind":{"type":"string","const":"Attio","isRequired":true,"uniqueKey":"result.deal.source.oneOf.0.kind","typeLabel":"string"},"attioId":{"type":"string","isRequired":true,"uniqueKey":"result.deal.source.oneOf.0.attioId","typeLabel":"string"},"attioWorkspaceId":{"type":"string","isRequired":true,"uniqueKey":"result.deal.source.oneOf.0.attioWorkspaceId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"result.deal.source.oneOf.0","typeLabel":"object"},{"type":"object","description":"The CRM the deal originates from, and its identifiers in that CRM.","required":["kind","hubspotId","hubspotWorkspaceId"],"properties":{"kind":{"type":"string","const":"Hubspot","isRequired":true,"uniqueKey":"result.deal.source.oneOf.1.kind","typeLabel":"string"},"hubspotId":{"type":"string","isRequired":true,"uniqueKey":"result.deal.source.oneOf.1.hubspotId","typeLabel":"string"},"hubspotWorkspaceId":{"type":"string","isRequired":true,"uniqueKey":"result.deal.source.oneOf.1.hubspotWorkspaceId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"result.deal.source.oneOf.1","typeLabel":"object"},{"type":"object","description":"The CRM the deal originates from, and its identifiers in that CRM.","required":["kind","pipedriveId","pipedriveCompanyId","pipedriveWorkspaceId"],"properties":{"kind":{"type":"string","const":"Pipedrive","isRequired":true,"uniqueKey":"result.deal.source.oneOf.2.kind","typeLabel":"string"},"pipedriveId":{"type":"number","isRequired":true,"uniqueKey":"result.deal.source.oneOf.2.pipedriveId","typeLabel":"number"},"pipedriveCompanyId":{"type":"number","isRequired":true,"uniqueKey":"result.deal.source.oneOf.2.pipedriveCompanyId","typeLabel":"number"},"pipedriveWorkspaceId":{"type":"number","isRequired":true,"uniqueKey":"result.deal.source.oneOf.2.pipedriveWorkspaceId","typeLabel":"number"}},"isRequired":true,"uniqueKey":"result.deal.source.oneOf.2","typeLabel":"object"},{"type":"object","description":"The CRM the deal originates from, and its identifiers in that CRM.","required":["kind","salesforceId","salesforceWorkspaceId"],"properties":{"kind":{"type":"string","const":"Salesforce","isRequired":true,"uniqueKey":"result.deal.source.oneOf.3.kind","typeLabel":"string"},"salesforceId":{"type":"string","isRequired":true,"uniqueKey":"result.deal.source.oneOf.3.salesforceId","typeLabel":"string"},"salesforceWorkspaceId":{"type":"string","isRequired":true,"uniqueKey":"result.deal.source.oneOf.3.salesforceWorkspaceId","typeLabel":"string"}},"isRequired":true,"uniqueKey":"result.deal.source.oneOf.3","typeLabel":"object"}],"isRequired":true,"uniqueKey":"result.deal.source","typeLabel":"object"},"url":{"type":"string","description":"The deal page URL in Claap application.","isRequired":true,"uniqueKey":"result.deal.url","typeLabel":"string"},"amount":{"type":"object","properties":{"currency":{"type":"string","description":"The amount currency, as configured in the CRM.","isRequired":true,"uniqueKey":"result.deal.amount.currency","typeLabel":"string"},"value":{"type":"number","description":"The deal amount.","uniqueKey":"result.deal.amount.value","typeLabel":"number"}},"required":["currency"],"description":"The deal amount.","uniqueKey":"result.deal.amount","typeLabel":"object"},"closedAt":{"type":"string","description":"The deal close date (ISO datetime).","uniqueKey":"result.deal.closedAt","typeLabel":"string"},"ownerEmail":{"type":"string","description":"The deal owner email.","uniqueKey":"result.deal.ownerEmail","typeLabel":"string"},"ownerId":{"type":"string","description":"The deal owner id in the CRM. This is the id accepted by the update endpoint, and the valid ids can be listed with the deal owners endpoint.","uniqueKey":"result.deal.ownerId","typeLabel":"string"},"ownerName":{"type":"string","description":"The deal owner name in the CRM.","uniqueKey":"result.deal.ownerName","typeLabel":"string"},"pipelineId":{"type":"string","description":"The pipeline id in the CRM. The pipeline label can be resolved with the deal stages endpoint.","uniqueKey":"result.deal.pipelineId","typeLabel":"string"},"stageId":{"type":"string","description":"The deal stage id in the CRM. This is the id accepted by the update endpoint, and its label can be resolved with the deal stages endpoint.","uniqueKey":"result.deal.stageId","typeLabel":"string"},"status":{"type":"string","enum":["Lost","Open","Won"],"description":"The deal status.","uniqueKey":"result.deal.status","typeLabel":"enum\u003cstring>"},"summary":{"type":"object","properties":{"markdown":{"type":"string","description":"The AI-generated deal summary, in Markdown.","isRequired":true,"uniqueKey":"result.deal.summary.markdown","typeLabel":"string"}},"required":["markdown"],"description":"The AI-generated deal summary. Absent until it has been generated for the first time.","uniqueKey":"result.deal.summary","typeLabel":"object"},"title":{"type":"string","description":"The deal title.","uniqueKey":"result.deal.title","typeLabel":"string"},"typeId":{"type":"string","description":"The deal type id in the CRM. This is the id accepted by the update endpoint, and its label can be resolved with the deal types endpoint.","uniqueKey":"result.deal.typeId","typeLabel":"string"}},"required":["dealId","companyIds","contactIds","openedAt","source","url"],"isRequired":true,"uniqueKey":"result.deal","typeLabel":"object"},"aiFields":{"type":"array","items":{"type":"object","properties":{"fieldId":{"type":"string","description":"The AI field identifier.","isRequired":true,"uniqueKey":"result.aiFields.items.[INDEX].fieldId","typeLabel":"string"},"title":{"type":"string","description":"The AI field title.","isRequired":true,"uniqueKey":"result.aiFields.items.[INDEX].title","typeLabel":"string"},"answer":{"oneOf":[{"type":"string","description":"The generated value, as Markdown. `null` unless `state` is `Ready`. For `Rating` fields, the value starts with the rating (e.g. `4/5`) followed by the justification with its **Proof** and **Gap** sections.","isRequired":true,"uniqueKey":"result.aiFields.items.[INDEX].answer.oneOf.0","typeLabel":"string"},{"type":"null","description":"The generated value, as Markdown. `null` unless `state` is `Ready`. For `Rating` fields, the value starts with the rating (e.g. `4/5`) followed by the justification with its **Proof** and **Gap** sections.","isRequired":true,"uniqueKey":"result.aiFields.items.[INDEX].answer.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result.aiFields.items.[INDEX].answer","typeLabel":"string | null"},"state":{"type":"string","enum":["Failed","Missing","Pending","Ready"],"description":"The generation state. `Missing` when no value has been generated for this deal.","isRequired":true,"uniqueKey":"result.aiFields.items.[INDEX].state","typeLabel":"enum\u003cstring>"}},"required":["fieldId","title","answer","state"],"description":"The value of an AI field for a given deal.","uniqueKey":"result.aiFields.items.[INDEX]","typeLabel":"object"},"description":"The AI field values of the deal, sorted by field title. Only returned when `returnAiFields` is set.","uniqueKey":"result.aiFields","typeLabel":"object[]"}},"required":["deal"],"isRequired":true,"uniqueKey":"result","typeLabel":"object"}},"required":["result"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"result":{"deal":{"dealId":"\u003cstring>","companyIds":["\u003cstring>"],"contactIds":["\u003cstring>"],"openedAt":"\u003cstring>","source":{"kind":"Attio","attioId":"\u003cstring>","attioWorkspaceId":"\u003cstring>"},"url":"\u003cstring>","amount":{"currency":"\u003cstring>","value":123},"closedAt":"\u003cstring>","ownerEmail":"\u003cstring>","ownerId":"\u003cstring>","ownerName":"\u003cstring>","pipelineId":"\u003cstring>","stageId":"\u003cstring>","status":"Lost","summary":{"markdown":"\u003cstring>"},"title":"\u003cstring>","typeId":"\u003cstring>"},"aiFields":[{"fieldId":"\u003cstring>","title":"\u003cstring>","answer":"\u003cstring>","state":"Failed"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"7b236799-41c1-4f60-804f-7e95170fc058":{"description":"Deal was not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"9666b11d-87f1-4fa8-8ecb-a775921bac48":{"ApiKey":{"type":"apiKey","in":"header","name":"X-Claap-Key","scopes":[],"schemeName":"ApiKey"}}},"servers":{"8ee810c4-540f-441a-9f25-6055c9139c4c":{"url":"https://api.claap.io/"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Claap-Key","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-Claap-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-Claap-Key"}],"title":"ApiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"claap","siteName":"Claap API","title":"Get deal details - Claap API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-11T07:38:50.005Z","originalFileLocation":"api-reference/endpoint/get_deal.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=\"Retrieve a deal.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Claap API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_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/claap/gczWElg9AVgfGA_0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get deal details - Claap API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a deal.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Claap API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.claap.io/api-reference/endpoint/get_deal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://claap.mintlify.app/_mintlify/api/og/v2?division=Deal\u0026amp;title=Get+deal+details\u0026amp;description=Retrieve+a+deal.\u0026amp;theme=6c082972569f3677fca0ebe9\u0026amp;signature=7b975e0504689153f41375942ebab93d9b1612a41e5ca9f3696ce5bdabc92ee0\">\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 deal details - Claap API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a deal.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://claap.mintlify.app/_mintlify/api/og/v2?division=Deal\u0026amp;title=Get+deal+details\u0026amp;description=Retrieve+a+deal.\u0026amp;theme=6c082972569f3677fca0ebe9\u0026amp;signature=7b975e0504689153f41375942ebab93d9b1612a41e5ca9f3696ce5bdabc92ee0\">\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/claap/gczWElg9AVgfGA_0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Claap API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5A81\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.claap.io/api-reference/endpoint/get_deal\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/get_deal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.claap.io/#organization\",\"name\":\"Claap API\",\"url\":\"https://docs.claap.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/claap/YMEmWPlbuWLR7Hpt/logo/claap.png?fit=max\u0026auto=format\u0026n=YMEmWPlbuWLR7Hpt\u0026q=85\u0026s=6f2f250d4d6c36e3ab820afc49e32fda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.claap.io#website\",\"name\":\"Claap API\",\"url\":\"https://docs.claap.io\",\"publisher\":{\"@id\":\"https://docs.claap.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.claap.io/api-reference/endpoint/get_deal#webpage\",\"url\":\"https://docs.claap.io/api-reference/endpoint/get_deal\",\"name\":\"Get deal details\",\"description\":\"Retrieve a deal.\",\"dateModified\":\"2026-08-11T07:38:50.005Z\",\"isPartOf\":{\"@id\":\"https://docs.claap.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.claap.io/api-reference/endpoint/get_deal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.claap.io/api-reference/endpoint/get_deal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Deal\",\"item\":\"https://docs.claap.io/api-reference/endpoint/list_deals\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get deal details\",\"item\":\"https://docs.claap.io/api-reference/endpoint/get_deal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.claap.io/api-reference/endpoint/get_deal#apireference\",\"headline\":\"Get deal details\",\"name\":\"Get deal details\",\"description\":\"Retrieve a deal.\",\"url\":\"https://docs.claap.io/api-reference/endpoint/get_deal\",\"mainEntityOfPage\":{\"@id\":\"https://docs.claap.io/api-reference/endpoint/get_deal#webpage\"},\"dateModified\":\"2026-08-11T07:38:50.005Z\",\"publisher\":{\"@id\":\"https://docs.claap.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.claap.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Claap API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Claap API","nav":{"global":null,"tabs":[{"tab":"API reference","groups":[{"group":"Getting started","pages":[{"title":"Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Responses \u0026 Errors","href":"/api-reference/errors"},{"title":"Quotas and Limits","href":"/api-reference/rate_limiting"},{"title":"Recordings Visibility","href":"/api-reference/recordings"},{"title":"Views","href":"/api-reference/views"},{"title":"AI fields","href":"/api-reference/ai_fields"},{"title":"Admin automations","href":"/api-reference/automations"}]},{"group":"Recording","pages":[{"title":"List recordings","openapi":"GET /v1/recordings","href":"/api-reference/endpoint/list_recordings"},{"title":"Get recording details","openapi":"GET /v1/recordings/{recordingId}","href":"/api-reference/endpoint/get_recording"},{"title":"Get recording transcript","openapi":"GET /v1/recordings/{recordingId}/transcript","href":"/api-reference/endpoint/get_recording_transcript"},{"title":"Create recording","openapi":"POST /v1/recordings","href":"/api-reference/endpoint/post_recording"},{"title":"Delete recording","openapi":"DELETE /v1/recordings/{recordingId}","href":"/api-reference/endpoint/delete_recording"},{"title":"List recording views","openapi":"GET /v1/recordings/views","href":"/api-reference/endpoint/list_recording_views"},{"title":"Get recording view details","openapi":"GET /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/get_recording_view"},{"title":"Create recording view","openapi":"POST /v1/recordings/views","href":"/api-reference/endpoint/post_recording_view"},{"title":"Update recording view","openapi":"PATCH /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/patch_recording_view"},{"title":"Delete recording view","openapi":"DELETE /v1/recordings/views/{viewId}","href":"/api-reference/endpoint/delete_recording_view"},{"title":"List pinned recording views","openapi":"GET /v1/recordings/views/pinned","href":"/api-reference/endpoint/list_pinned_recording_views"},{"title":"Update pinned recording views","openapi":"PUT /v1/recordings/views/pinned","href":"/api-reference/endpoint/put_pinned_recording_views"},{"title":"List recording AI fields","openapi":"GET /v1/recordings/fields","href":"/api-reference/endpoint/list_recording_ai_fields"},{"title":"Get recording AI field","openapi":"GET /v1/recordings/fields/{fieldId}","href":"/api-reference/endpoint/get_recording_ai_field"},{"title":"Create recording AI field","openapi":"POST /v1/recordings/fields","href":"/api-reference/endpoint/post_recording_ai_field"},{"title":"Update recording AI field","openapi":"PUT /v1/recordings/fields/{fieldId}","href":"/api-reference/endpoint/put_recording_ai_field"},{"title":"Archive recording AI field","openapi":"POST /v1/recordings/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_recording_ai_field"},{"title":"Generate recording AI field","openapi":"POST /v1/recordings/fields/{fieldId}/generations","href":"/api-reference/endpoint/generate_recording_ai_field"},{"title":"Get recording AI field generation","openapi":"GET /v1/recordings/fields/generations/{generationId}","href":"/api-reference/endpoint/get_recording_ai_field_generation"},{"title":"Cancel recording AI field generation","openapi":"POST /v1/recordings/fields/generations/{generationId}/cancel","href":"/api-reference/endpoint/cancel_recording_ai_field_generation"}]},{"group":"Deal","pages":[{"title":"List deals","openapi":"GET /v1/deals","description":"List deals, most recently opened first by default.","href":"/api-reference/endpoint/list_deals"},{"title":"Get deal details","openapi":"GET /v1/deals/{dealId}","href":"/api-reference/endpoint/get_deal"},{"title":"Update deal","openapi":"PATCH /v1/deals/{dealId}","description":"Update a deal. The update is written to the connected CRM first, then mirrored in Claap. At least one field must be provided; omitted fields keep their current values.","href":"/api-reference/endpoint/patch_deal"},{"title":"List deal stages","openapi":"GET /v1/deals/stages","href":"/api-reference/endpoint/list_deal_stages"},{"title":"List deal types","openapi":"GET /v1/deals/types","href":"/api-reference/endpoint/list_deal_types"},{"title":"List deal owners","openapi":"GET /v1/deals/owners","href":"/api-reference/endpoint/list_deal_owners"},{"title":"List deal views","openapi":"GET /v1/deals/views","href":"/api-reference/endpoint/list_deal_views"},{"title":"Get deal view details","openapi":"GET /v1/deals/views/{viewId}","href":"/api-reference/endpoint/get_deal_view"},{"title":"Create deal view","openapi":"POST /v1/deals/views","href":"/api-reference/endpoint/post_deal_view"},{"title":"Update deal view","openapi":"PATCH /v1/deals/views/{viewId}","href":"/api-reference/endpoint/patch_deal_view"},{"title":"Delete deal view","openapi":"DELETE /v1/deals/views/{viewId}","href":"/api-reference/endpoint/delete_deal_view"},{"title":"List pinned deal views","openapi":"GET /v1/deals/views/pinned","href":"/api-reference/endpoint/list_pinned_deal_views"},{"title":"Update pinned deal views","openapi":"PUT /v1/deals/views/pinned","href":"/api-reference/endpoint/put_pinned_deal_views"},{"title":"List deal AI fields","openapi":"GET /v1/deals/fields","href":"/api-reference/endpoint/list_deal_ai_fields"},{"title":"Get deal AI field","openapi":"GET /v1/deals/fields/{fieldId}","href":"/api-reference/endpoint/get_deal_ai_field"},{"title":"Create deal AI field","openapi":"POST /v1/deals/fields","href":"/api-reference/endpoint/post_deal_ai_field"},{"title":"Update deal AI field","openapi":"PUT /v1/deals/fields/{fieldId}","href":"/api-reference/endpoint/put_deal_ai_field"},{"title":"Archive deal AI field","openapi":"POST /v1/deals/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_deal_ai_field"},{"title":"Generate deal AI field","openapi":"POST /v1/deals/fields/{fieldId}/generations","href":"/api-reference/endpoint/generate_deal_ai_field"},{"title":"Get deal AI field generation","openapi":"GET /v1/deals/fields/generations/{generationId}","href":"/api-reference/endpoint/get_deal_ai_field_generation"},{"title":"Cancel deal AI field generation","openapi":"POST /v1/deals/fields/generations/{generationId}/cancel","href":"/api-reference/endpoint/cancel_deal_ai_field_generation"}]},{"group":"Company","pages":[{"title":"List companies","openapi":"GET /v1/companies","href":"/api-reference/endpoint/list_companies"},{"title":"Get company details","openapi":"GET /v1/companies/{companyId}","href":"/api-reference/endpoint/get_company"},{"title":"List company views","openapi":"GET /v1/companies/views","href":"/api-reference/endpoint/list_company_views"},{"title":"Get company view details","openapi":"GET /v1/companies/views/{viewId}","href":"/api-reference/endpoint/get_company_view"},{"title":"Create company view","openapi":"POST /v1/companies/views","href":"/api-reference/endpoint/post_company_view"},{"title":"Update company view","openapi":"PATCH /v1/companies/views/{viewId}","href":"/api-reference/endpoint/patch_company_view"},{"title":"Delete company view","openapi":"DELETE /v1/companies/views/{viewId}","href":"/api-reference/endpoint/delete_company_view"},{"title":"List pinned company views","openapi":"GET /v1/companies/views/pinned","href":"/api-reference/endpoint/list_pinned_company_views"},{"title":"Update pinned company views","openapi":"PUT /v1/companies/views/pinned","href":"/api-reference/endpoint/put_pinned_company_views"},{"title":"List company AI fields","openapi":"GET /v1/companies/fields","href":"/api-reference/endpoint/list_company_ai_fields"},{"title":"Get company AI field","openapi":"GET /v1/companies/fields/{fieldId}","href":"/api-reference/endpoint/get_company_ai_field"},{"title":"Create company AI field","openapi":"POST /v1/companies/fields","href":"/api-reference/endpoint/post_company_ai_field"},{"title":"Update company AI field","openapi":"PUT /v1/companies/fields/{fieldId}","href":"/api-reference/endpoint/put_company_ai_field"},{"title":"Archive company AI field","openapi":"POST /v1/companies/fields/{fieldId}/archive","href":"/api-reference/endpoint/archive_company_ai_field"}]},{"group":"Contact","pages":[{"title":"List contacts","openapi":"GET /v1/contacts","href":"/api-reference/endpoint/list_contacts"},{"title":"Get contact details","openapi":"GET /v1/contacts/{contactId}","href":"/api-reference/endpoint/get_contact"},{"title":"Create contact","openapi":"POST /v1/contacts","href":"/api-reference/endpoint/post_contact"},{"title":"Update contact","openapi":"PATCH /v1/contacts/{contactId}","href":"/api-reference/endpoint/patch_contact"},{"title":"List contact views","openapi":"GET /v1/contacts/views","href":"/api-reference/endpoint/list_contact_views"},{"title":"Get contact view details","openapi":"GET /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/get_contact_view"},{"title":"Create contact view","openapi":"POST /v1/contacts/views","href":"/api-reference/endpoint/post_contact_view"},{"title":"Update contact view","openapi":"PATCH /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/patch_contact_view"},{"title":"Delete contact view","openapi":"DELETE /v1/contacts/views/{viewId}","href":"/api-reference/endpoint/delete_contact_view"},{"title":"List pinned contact views","openapi":"GET /v1/contacts/views/pinned","href":"/api-reference/endpoint/list_pinned_contact_views"},{"title":"Update pinned contact views","openapi":"PUT /v1/contacts/views/pinned","href":"/api-reference/endpoint/put_pinned_contact_views"}]},{"group":"Folder","pages":[{"title":"Get folder details","openapi":"GET /v1/folders/{folderId}","href":"/api-reference/endpoint/get_folder"},{"title":"Create folder","openapi":"POST /v1/folders","href":"/api-reference/endpoint/post_folder"},{"title":"Update folder","openapi":"PATCH /v1/folders/{folderId}","href":"/api-reference/endpoint/patch_folder"},{"title":"Delete folder","openapi":"DELETE /v1/folders/{folderId}","href":"/api-reference/endpoint/delete_folder"}]},{"group":"Admin automation","pages":[{"title":"List admin automations","openapi":"GET /v1/admin-automations","href":"/api-reference/endpoint/list_admin_automations"},{"title":"Get admin automation","openapi":"GET /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/get_admin_automation"},{"title":"Create admin automation","openapi":"POST /v1/admin-automations","href":"/api-reference/endpoint/post_admin_automation"},{"title":"Update admin automation","openapi":"PUT /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/put_admin_automation"},{"title":"Delete admin automation","openapi":"DELETE /v1/admin-automations/{adminAutomationId}","href":"/api-reference/endpoint/delete_admin_automation"}]},{"group":"Workspace","pages":[{"title":"Get workspace information","openapi":"GET /v1/workspaces/mine","href":"/api-reference/endpoint/get_workspace"}]},{"group":"User","pages":[{"title":"List users","openapi":"GET /v1/users","href":"/api-reference/endpoint/list_users"},{"title":"Get user details","openapi":"GET /v1/users/{userId}","href":"/api-reference/endpoint/get_user"},{"title":"Update user","openapi":"PATCH /v1/users/{userId}","href":"/api-reference/endpoint/patch_user"}]},{"group":"Invite","pages":[{"title":"List invites","openapi":"GET /v1/invites","href":"/api-reference/endpoint/list_invites"},{"title":"Invite users","openapi":"POST /v1/invites","href":"/api-reference/endpoint/post_invite"},{"title":"Resend invite","openapi":"POST /v1/invites/{email}/resend","href":"/api-reference/endpoint/resend_invite"},{"title":"Cancel invite","openapi":"DELETE /v1/invites/{email}","href":"/api-reference/endpoint/delete_invite"}]},{"group":"User group","pages":[{"title":"List user groups","openapi":"GET /v1/user-groups","href":"/api-reference/endpoint/list_user_groups"},{"title":"Create user group","openapi":"POST /v1/user-groups","href":"/api-reference/endpoint/post_user_group"},{"title":"Update user group","openapi":"PATCH /v1/user-groups/{userGroupId}","href":"/api-reference/endpoint/patch_user_group"},{"title":"Delete user group","openapi":"DELETE /v1/user-groups/{userGroupId}","href":"/api-reference/endpoint/delete_user_group"}]},{"group":"Webhook","pages":[{"title":"Trigger webhook","openapi":"POST /v1/webhooks/{webhookId}/trigger","href":"/api-reference/endpoint/trigger_webhook"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/setup"}]},{"tab":"Webhook reference","pages":[{"title":"Webhook reference","href":"/api-reference/webhooks"}]}]},"title":"Get deal details - Claap API","buildId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","deploymentId":"dpl_HcHmUS6i3UwswnTHJUEdcTtwfdTQ","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-BRm_l__d.js","utils-f1l1Oc-G.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BlhqDhJO.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DHCB7rsC.js","snippetPresets-CYXLx6Hv.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-kQh739Uz.js","ApiExamples-B78P2dEq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C4YLPVAh.js","shallow-vlLnTDkQ.js","getApiPlaygroundDisplay-D_98hhvf.js","CodeSnippet-DtnZHGqq.js","CodeSnippets-CLFb8KJt.js","getPastedJson-Cq-zlbnU.js","icon-sN3t983t.js","MethodPill-P_YQ2s09.js","DuplicateIcon-BVzyNsGJ.js","createIcon-B3jqgqC6.js","DynamicMarkdown-Crwq6WG_.js","SectionHeading-C7pGS2Bb.js","axios-vUo_bRtp.js","Markdown-BuPH8yuW.js","clsx-CCOYKgaU.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BnkC_6oA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BM4S31-f.js"]}