Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the deals:read scope.
A deal as /v1 publishes it: the deal itself plus its assignments (agents) and parties. Money is a fixed-2dp decimal string, calendar dates are YYYY-MM-DD, timestamps are ISO 8601 UTC, and null means the column is not captured rather than zero or empty.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"myAbode Deals Docs","description":"Documentation for myAbode Deals: AI-native deal processing for Canadian real estate brokerages. Guides for agents and office admins, and the myAbode Deals API.","colors":{"primary":"#304c89","light":"#fff596","dark":"#304c89"},"logo":{"light":"https://mintcdn.com/myabode/s2kJmoAiYZgNJ3TU/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=s2kJmoAiYZgNJ3TU\u0026q=85\u0026s=7b0c764b0d185d4dc7c7c35a35ad86f4","dark":"https://mintcdn.com/myabode/s2kJmoAiYZgNJ3TU/logo/wordmark-dark.svg?fit=max\u0026auto=format\u0026n=s2kJmoAiYZgNJ3TU\u0026q=85\u0026s=43dfeb3cdc6e60bdfeb12c19025bd7e7"},"favicon":"https://mintcdn.com/myabode/s2kJmoAiYZgNJ3TU/favicon.svg?fit=max\u0026auto=format\u0026n=s2kJmoAiYZgNJ3TU\u0026q=85\u0026s=4adfa0965e28a3348885387c88c4c332","api":{"playground":{"display":"simple"},"examples":{"languages":["bash","javascript","python"]}},"appearance":{"default":"dark"},"background":{"color":{"light":"#faf9f5","dark":"#070d1d"}},"navbar":{"links":[{"href":"https://myabode.ca","label":"myabode.ca"}],"primary":{"type":"button","label":"Sign in","href":"https://app.myabode.ca"}},"footer":{"socials":{"website":"https://myabode.ca"}},"fonts":{"body":{"family":"Plus Jakarta Sans","weight":400,"source":"fonts/plus-jakarta-sans-latin-wght-normal.woff2","format":"woff2"}},"icons":{"library":"lucide"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"myabode","hasAudioNarration":false,"actualSubdomain":"myabode","customDomains":["docs.myabode.ca"],"gitSource":{"type":"github","owner":"myabode","repo":"myabode_platform","deployBranch":"docs-live","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6af20c63c8cb8c8121857b1e"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af261c5af286a8c18ad1b6d","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"API","count":18},{"language":"default","tag":"For agents","count":13},{"language":"default","tag":"Endpoint reference","count":10},{"language":"default","tag":"API Reference","count":10},{"language":"default","tag":"For office admins","count":9},{"language":"default","tag":"API guides","count":8},{"language":"default","tag":"Getting started","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":[{"filePath":"style.css","content":"@font-face{font-family:\"Plus Jakarta Sans\";src:url(\"/fonts/plus-jakarta-sans-latin-wght-normal.woff2\") format(\"woff2\");font-weight:200 800;font-style:normal;font-display:swap}@font-face{font-family:\"Plus Jakarta Sans\";src:url(\"/fonts/plus-jakarta-sans-latin-wght-italic.woff2\") format(\"woff2\");font-weight:200 800;font-style:italic;font-display:swap}@font-face{font-family:\"Lora\";src:url(\"/fonts/lora-latin-wght-normal.woff2\") format(\"woff2\");font-weight:400 700;font-style:normal;font-display:swap}@font-face{font-family:\"JetBrains Mono\";src:url(\"/fonts/jetbrains-mono-latin-wght-normal.woff2\") format(\"woff2\");font-weight:100 800;font-style:normal;font-display:swap}:root{--mya-heading-font: \"Lora\", Georgia, serif;--mya-mono-font: \"JetBrains Mono\", ui-monospace, Menlo, monospace;--mya-sunbeam: #fff8b7;--mya-obsidian: #070d1d;--mya-blueprint: #1c3875;--mya-heritage-blue: #304c89;--mya-hairline-dark: #16244a;--mya-hairline-light: #e4e2d9}#page-title,#content h1,#content h2,#content h3,[data-component-part=\"card-title\"]{font-family:var(--mya-heading-font);font-weight:500;letter-spacing:-0.01em}#content code,#content pre,[data-component-part=\"code-block-root\"]{font-family:var(--mya-mono-font)}html.dark [data-layout-item=\"topbar\"],html.dark [data-layout-item=\"sidebar\"]{background-color:var(--mya-obsidian);border-color:var(--mya-hairline-dark)}.card{border-radius:20px}html.dark .card{border-color:var(--mya-blueprint)}#content img{border:1px solid var(--mya-hairline-light);border-radius:12px}html.dark #content img{border-color:var(--mya-blueprint)}.mya-button{display:inline-flex;align-items:center;gap:0.5rem;padding:0.7rem 1.4rem;border-radius:9999px;font-weight:500;text-decoration:none;border:1px solid transparent}.mya-button-primary{background:var(--mya-heritage-blue);color:#fff}html.dark .mya-button-primary{background:var(--mya-sunbeam);color:var(--mya-obsidian)}.mya-button-secondary{border-color:currentColor}#topbar-cta-button a>span:first-child{border-radius:9999px}html.dark #topbar-cta-button a>span:first-child{background:var(--mya-sunbeam)}html.dark #topbar-cta-button a div,html.dark #topbar-cta-button a div span{color:var(--mya-obsidian)}[data-layout-item=\"topbar\"] a:has(>img.nav-logo){display:flex;align-items:center}img.nav-logo{height:2rem}[data-layout-item=\"topbar\"] a:has(>img.nav-logo)::after{content:\"Docs\";margin-inline-start:0.75rem;padding-inline-start:0.75rem;border-inline-start:1px solid currentColor;font-family:var(--mya-heading-font);font-size:1.25rem;line-height:1;opacity:0.85}"}],"page":{"pagePath":"api/reference/retrieve-a-deal","slug":"/api/reference/retrieve-a-deal","pageMetadata":{"title":"Retrieve a deal","description":"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the `deals:read` scope.","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/deals/{id}","href":"/api/reference/retrieve-a-deal","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the \", _jsx(_components.code, {\n children: \"deals:read\"\n }), \" scope.\"]\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":"Retrieve a deal","description":"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the `deals:read` scope.","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/deals/{id}","href":"/api/reference/retrieve-a-deal","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"deals.get","summary":"Retrieve a deal","description":"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the `deals:read` scope.","parameters":["5656f9d2-6dee-47b9-b751-a3bafb3b171a"],"responses":{"200":"aed46353-b932-4131-ba28-332c5f610b59","400":"c21cadd2-9907-42d8-a5ce-a40adc2f1b03","401":"0afe3e0b-1250-4f1d-bda2-be4cf877df5a","403":"00fd3e82-44ef-4a07-a049-75340f14818d","404":"53cb111f-83ed-4c82-91f8-2cccc6fb481a","429":"21faf1d6-a3f2-47a6-868e-5055a6071c6f"},"method":"get","type":"path","servers":["6b87dc34-26e7-4c9c-90de-6060a31aedae"],"security":["f931d093-7aa2-488d-8e19-f868ac754cb8"],"path":"/v1/deals/{id}","baseUrlOptions":["https://api.myabode.ca"],"title":"Retrieve a deal","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5656f9d2-6dee-47b9-b751-a3bafb3b171a":{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"aed46353-b932-4131-ba28-332c5f610b59":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"const":"deal","isRequired":true,"uniqueKey":"object","typeLabel":"any"},"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"brokerage":{"type":"string","isRequired":true,"uniqueKey":"brokerage","typeLabel":"string"},"office":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"office.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"office.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"office","typeLabel":"string | null"},"status":{"enum":["SUBMITTED","IN_PROGRESS","READY_FOR_PAYOUT","PAID_OUT","COMPLETED","FELL_THROUGH"],"type":"string","description":"Deal status. New values may be added; this is not a breaking change. Handle unknown values.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"deal_type":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"deal_type.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"deal_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"deal_type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"title","typeLabel":"string | null"},"mls_number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"mls_number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"mls_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mls_number","typeLabel":"string | null"},"jurisdiction_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"jurisdiction_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"jurisdiction_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jurisdiction_code","typeLabel":"string | null"},"address":{"type":"object","properties":{"line1":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"address.line1.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"address.line1.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.line1","typeLabel":"string | null"},"line2":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"address.line2.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"address.line2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.line2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"address.city.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"address.city.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.city","typeLabel":"string | null"},"province":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"address.province.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"address.province.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.province","typeLabel":"string | null"},"postal_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"address.postal_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"address.postal_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"address.postal_code","typeLabel":"string | null"}},"required":["line1","line2","city","province","postal_code"],"additionalProperties":false,"isRequired":true,"uniqueKey":"address","typeLabel":"object"},"list_price":{"oneOf":[{"type":"string","pattern":"^-?\\d+\\.\\d{2}$","isRequired":true,"uniqueKey":"list_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"list_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"list_price","typeLabel":"string | null"},"accepted_price":{"oneOf":[{"type":"string","pattern":"^-?\\d+\\.\\d{2}$","isRequired":true,"uniqueKey":"accepted_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"accepted_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accepted_price","typeLabel":"string | null"},"sale_price":{"oneOf":[{"type":"string","pattern":"^-?\\d+\\.\\d{2}$","isRequired":true,"uniqueKey":"sale_price.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"sale_price.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"sale_price","typeLabel":"string | null"},"monthly_rent":{"oneOf":[{"type":"string","pattern":"^-?\\d+\\.\\d{2}$","isRequired":true,"uniqueKey":"monthly_rent.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"monthly_rent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"monthly_rent","typeLabel":"string | null"},"lease_term_months":{"oneOf":[{"type":"integer","maximum":9007199254740991,"minimum":-9007199254740991,"isRequired":true,"uniqueKey":"lease_term_months.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"lease_term_months.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lease_term_months","typeLabel":"integer | null"},"offer_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"offer_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","isRequired":true,"uniqueKey":"offer_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"offer_date","typeLabel":"string\u003cdate> | null"},"accepted_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"accepted_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","isRequired":true,"uniqueKey":"accepted_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"accepted_date","typeLabel":"string\u003cdate> | null"},"firm_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"firm_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","isRequired":true,"uniqueKey":"firm_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"firm_date","typeLabel":"string\u003cdate> | null"},"close_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"close_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","isRequired":true,"uniqueKey":"close_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"close_date","typeLabel":"string\u003cdate> | null"},"lease_start_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"lease_start_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","isRequired":true,"uniqueKey":"lease_start_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lease_start_date","typeLabel":"string\u003cdate> | null"},"listing_expiry_date":{"oneOf":[{"type":"string","format":"date","isRequired":true,"uniqueKey":"listing_expiry_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","isRequired":true,"uniqueKey":"listing_expiry_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"listing_expiry_date","typeLabel":"string\u003cdate> | null"},"is_exclusive_listing":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"is_exclusive_listing.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"is_exclusive_listing.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"is_exclusive_listing","typeLabel":"boolean | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"url":{"type":"string","isRequired":true,"uniqueKey":"url","typeLabel":"string"},"agents":{"type":"array","items":{"type":"object","properties":{"user":{"type":"object","properties":{"type":{"const":"user","isRequired":true,"uniqueKey":"agents.items.[INDEX].user.type","typeLabel":"any"},"id":{"type":"string","isRequired":true,"uniqueKey":"agents.items.[INDEX].user.id","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"agents.items.[INDEX].user.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"agents.items.[INDEX].user.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].user.name","typeLabel":"string | null"}},"required":["type","id","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"agents.items.[INDEX].user","typeLabel":"object"},"role":{"oneOf":[{"type":"string","description":"Agent role. New values may be added; this is not a breaking change. Handle unknown values.","enum":["PRIMARY","CO_AGENT","ASSISTANT","REFERRAL"],"isRequired":true,"uniqueKey":"agents.items.[INDEX].role.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"agents.items.[INDEX].role.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].role","typeLabel":"enum\u003cstring> | null"},"side":{"oneOf":[{"type":"string","description":"Deal side. New values may be added; this is not a breaking change. Handle unknown values.","enum":["LISTING","COOP"],"isRequired":true,"uniqueKey":"agents.items.[INDEX].side.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"agents.items.[INDEX].side.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].side","typeLabel":"enum\u003cstring> | null"},"is_primary":{"type":"boolean","isRequired":true,"uniqueKey":"agents.items.[INDEX].is_primary","typeLabel":"boolean"}},"required":["user","role","side","is_primary"],"additionalProperties":false,"uniqueKey":"agents.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"agents","typeLabel":"object[]"},"parties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"parties.items.[INDEX].id","typeLabel":"string"},"type":{"enum":["PERSON","ORGANIZATION"],"type":"string","description":"Party type. New values may be added; this is not a breaking change. Handle unknown values.","isRequired":true,"uniqueKey":"parties.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"parties.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"parties.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parties.items.[INDEX].name","typeLabel":"string | null"},"organization_name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"parties.items.[INDEX].organization_name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"parties.items.[INDEX].organization_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parties.items.[INDEX].organization_name","typeLabel":"string | null"},"role":{"enum":["BUYER","SELLER","TENANT_PARTY","LANDLORD_PARTY","BUYER_LAWYER","SELLER_LAWYER","COOP_AGENT","LISTING_AGENT"],"type":"string","description":"Party role. New values may be added; this is not a breaking change. Handle unknown values.","isRequired":true,"uniqueKey":"parties.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"participant_type":{"enum":["CLIENT","COUNTERPARTY","PROFESSIONAL","EXTERNAL_AGENT"],"type":"string","description":"Participant type. New values may be added; this is not a breaking change. Handle unknown values.","isRequired":true,"uniqueKey":"parties.items.[INDEX].participant_type","typeLabel":"enum\u003cstring>"},"side":{"enum":["LISTING","COOP"],"type":"string","description":"Deal side. New values may be added; this is not a breaking change. Handle unknown values.","isRequired":true,"uniqueKey":"parties.items.[INDEX].side","typeLabel":"enum\u003cstring>"},"email":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"parties.items.[INDEX].email.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"parties.items.[INDEX].email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parties.items.[INDEX].email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"parties.items.[INDEX].phone.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"parties.items.[INDEX].phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"parties.items.[INDEX].phone","typeLabel":"string | null"}},"required":["id","type","name","organization_name","role","participant_type","side","email","phone"],"additionalProperties":false,"uniqueKey":"parties.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"parties","typeLabel":"object[]"}},"required":["object","id","brokerage","office","status","deal_type","title","mls_number","jurisdiction_code","address","list_price","accepted_price","sale_price","monthly_rent","lease_term_months","offer_date","accepted_date","firm_date","close_date","lease_start_date","listing_expiry_date","is_exclusive_listing","created_at","updated_at","url","agents","parties"],"additionalProperties":false,"description":"A deal as `/v1` publishes it: the deal itself plus its assignments (`agents`) and parties. Money is a fixed-2dp decimal string, calendar dates are `YYYY-MM-DD`, timestamps are ISO 8601 UTC, and `null` means the column is not captured rather than zero or empty.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"object":"deal","id":"\u003cstring>","brokerage":"\u003cstring>","office":"\u003cstring>","status":"SUBMITTED","deal_type":"\u003cstring>","title":"\u003cstring>","mls_number":"\u003cstring>","jurisdiction_code":"\u003cstring>","address":{"line1":"\u003cstring>","line2":"\u003cstring>","city":"\u003cstring>","province":"\u003cstring>","postal_code":"\u003cstring>"},"list_price":"\u003cstring>","accepted_price":"\u003cstring>","sale_price":"\u003cstring>","monthly_rent":"\u003cstring>","lease_term_months":0,"offer_date":"2023-12-25","accepted_date":"2023-12-25","firm_date":"2023-12-25","close_date":"2023-12-25","lease_start_date":"2023-12-25","listing_expiry_date":"2023-12-25","is_exclusive_listing":true,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","url":"\u003cstring>","agents":[{"user":{"type":"user","id":"\u003cstring>","name":"\u003cstring>"},"role":"PRIMARY","side":"LISTING","is_primary":true}],"parties":[{"id":"\u003cstring>","type":"PERSON","name":"\u003cstring>","organization_name":"\u003cstring>","role":"BUYER","participant_type":"CLIENT","side":"LISTING","email":"\u003cstring>","phone":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"c21cadd2-9907-42d8-a5ce-a40adc2f1b03":{"description":"A parameter failed validation — a filter, a paging value or the path id. `errors[]` names each rejected value with a JSON Pointer. A `cursor` this API cannot read, or one sent with a different `sort`, is `INVALID_CURSOR` and fails the same way on every retry: drop it and re-run the initial sync (on `/v1/events`, from `start=latest`, as for a 410).","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resource":{"type":"string","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"string"}},"required":["pointer","code","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status","detail","code","request_id"],"additionalProperties":false,"description":"RFC 9457 Problem Details — the only error body the `/v1` surface emits, served as `application/problem+json` on every failure. Branch on `code`, not on `title` or `detail`; quote `request_id` (also the `Request-Id` response header) in a support request. `errors` is present only on a 400, carrying one entry per rejected field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","code":"\u003cstring>","request_id":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>","resource":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"0afe3e0b-1250-4f1d-bda2-be4cf877df5a":{"description":"No `Authorization: Bearer mya_…` header (`API_KEY_REQUIRED`), or a credential this API will not accept (`API_KEY_INVALID`). Unknown, revoked and expired keys are one outcome.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resource":{"type":"string","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"string"}},"required":["pointer","code","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status","detail","code","request_id"],"additionalProperties":false,"description":"RFC 9457 Problem Details — the only error body the `/v1` surface emits, served as `application/problem+json` on every failure. Branch on `code`, not on `title` or `detail`; quote `request_id` (also the `Request-Id` response header) in a support request. `errors` is present only on a 400, carrying one entry per rejected field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","code":"\u003cstring>","request_id":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>","resource":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"00fd3e82-44ef-4a07-a049-75340f14818d":{"description":"The key is valid but does not hold the scope this route requires (`INSUFFICIENT_SCOPE`).","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resource":{"type":"string","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"string"}},"required":["pointer","code","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status","detail","code","request_id"],"additionalProperties":false,"description":"RFC 9457 Problem Details — the only error body the `/v1` surface emits, served as `application/problem+json` on every failure. Branch on `code`, not on `title` or `detail`; quote `request_id` (also the `Request-Id` response header) in a support request. `errors` is present only on a 400, carrying one entry per rejected field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","code":"\u003cstring>","request_id":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>","resource":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"53cb111f-83ed-4c82-91f8-2cccc6fb481a":{"description":"No such resource, or none this key may read — the two answers are identical bar `request_id` (`NOT_FOUND`).","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resource":{"type":"string","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"string"}},"required":["pointer","code","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status","detail","code","request_id"],"additionalProperties":false,"description":"RFC 9457 Problem Details — the only error body the `/v1` surface emits, served as `application/problem+json` on every failure. Branch on `code`, not on `title` or `detail`; quote `request_id` (also the `Request-Id` response header) in a support request. `errors` is present only on a 400, carrying one entry per rejected field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","code":"\u003cstring>","request_id":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>","resource":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"21faf1d6-a3f2-47a6-868e-5055a6071c6f":{"description":"The key spent its per-minute request budget (`RATE_LIMITED`). `Retry-After` carries the seconds to wait.","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"pointer":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].pointer","typeLabel":"string"},"code":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"},"resource":{"type":"string","uniqueKey":"errors.items.[INDEX].resource","typeLabel":"string"}},"required":["pointer","code","detail"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"required":["type","title","status","detail","code","request_id"],"additionalProperties":false,"description":"RFC 9457 Problem Details — the only error body the `/v1` surface emits, served as `application/problem+json` on every failure. Branch on `code`, not on `title` or `detail`; quote `request_id` (also the `Request-Id` response header) in a support request. `errors` is present only on a 400, carrying one entry per rejected field.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":0,"detail":"\u003cstring>","code":"\u003cstring>","request_id":"\u003cstring>","errors":[{"pointer":"\u003cstring>","code":"\u003cstring>","detail":"\u003cstring>","resource":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f931d093-7aa2-488d-8e19-f868ac754cb8":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key of the form `mya_…`, sent as `Authorization: Bearer mya_…`. The secret is shown once, when the key is created.","scopes":[],"schemeName":"apiKey"}}},"servers":{"6b87dc34-26e7-4c9c-90de-6060a31aedae":{"url":"https://api.myabode.ca"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key of the form `mya_…`, sent as `Authorization: Bearer mya_…`. The secret is shown once, when the key is created.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key of the form `mya_…`, sent as `Authorization: Bearer mya_…`. The secret is shown once, when the key is created.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"https://api.myabode.ca/v1/openapi.json"},"subdomain":"myabode","siteName":"myAbode Deals Docs","title":"Retrieve a deal - myAbode Deals Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T23:50:53.318Z","originalFileLocation":"api/reference/retrieve-a-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=\"dark\"}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=\"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the deals:read scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"myAbode Deals Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_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/myabode/MI1ZqPOpUaR-yg_6/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a deal - myAbode Deals Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the deals:read scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"myAbode Deals Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.myabode.ca/api/reference/retrieve-a-deal\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://myabode.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Retrieve+a+deal\u0026amp;description=Returns+the+deal+when+the+member+the+key+belongs+to+can+read+it.+A+deal+that+does+not+exist+and+a+deal+that+member+cannot+see+both+return+404+NOT_FOUND+with+an+\u0026amp;theme=9844e1951fc266a0bf7bd977\u0026amp;signature=7a2055eea9559de29f292c89f60e4e0f1e2b4d5bbd9cc198525ab5958b0da09c\">\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=\"Retrieve a deal - myAbode Deals Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the deals:read scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://myabode.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Retrieve+a+deal\u0026amp;description=Returns+the+deal+when+the+member+the+key+belongs+to+can+read+it.+A+deal+that+does+not+exist+and+a+deal+that+member+cannot+see+both+return+404+NOT_FOUND+with+an+\u0026amp;theme=9844e1951fc266a0bf7bd977\u0026amp;signature=7a2055eea9559de29f292c89f60e4e0f1e2b4d5bbd9cc198525ab5958b0da09c\">\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/myabode/MI1ZqPOpUaR-yg_6/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"myAbode Deals Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#304c89\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.myabode.ca/api/reference/retrieve-a-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/retrieve-a-deal.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.myabode.ca/#organization\",\"name\":\"myAbode Deals Docs\",\"url\":\"https://docs.myabode.ca\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/myabode/s2kJmoAiYZgNJ3TU/logo/wordmark-light.svg?fit=max\u0026auto=format\u0026n=s2kJmoAiYZgNJ3TU\u0026q=85\u0026s=7b0c764b0d185d4dc7c7c35a35ad86f4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.myabode.ca#website\",\"name\":\"myAbode Deals Docs\",\"url\":\"https://docs.myabode.ca\",\"publisher\":{\"@id\":\"https://docs.myabode.ca/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal#webpage\",\"url\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal\",\"name\":\"Retrieve a deal\",\"description\":\"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the deals:read scope.\",\"dateModified\":\"2026-11-09T23:50:53.318Z\",\"isPartOf\":{\"@id\":\"https://docs.myabode.ca#website\"},\"breadcrumb\":{\"@id\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoint reference\",\"item\":\"https://docs.myabode.ca/api/reference/list-brokerages\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.myabode.ca/api/reference/list-brokerages\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a deal\",\"item\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal#apireference\",\"headline\":\"Retrieve a deal\",\"name\":\"Retrieve a deal\",\"description\":\"Returns the deal when the member the key belongs to can read it. A deal that does not exist and a deal that member cannot see both return 404 NOT_FOUND with an identical body. Requires the deals:read scope.\",\"url\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal\",\"mainEntityOfPage\":{\"@id\":\"https://docs.myabode.ca/api/reference/retrieve-a-deal#webpage\"},\"dateModified\":\"2026-11-09T23:50:53.318Z\",\"publisher\":{\"@id\":\"https://docs.myabode.ca/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.myabode.ca#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"myAbode Deals Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"myAbode Deals Docs","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API","groups":[{"group":"API guides","pages":[{"title":"myAbode Deals API","sidebarTitle":"API overview","href":"/api"},{"title":"Quickstart: list your deals","sidebarTitle":"Quickstart","href":"/api/quickstart"},{"title":"Authentication and API keys","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"Partner applications","href":"/api/partner-applications"},{"title":"Pagination and filtering","sidebarTitle":"Pagination","href":"/api/pagination"},{"title":"Events: keep your system in sync","sidebarTitle":"Events","href":"/api/events"},{"title":"Errors","href":"/api/errors"},{"title":"Rate limits","href":"/api/rate-limits"}]},{"group":"Endpoint reference","pages":[{"group":"API Reference","pages":[{"title":"List brokerages","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/brokerages","href":"/api/reference/list-brokerages"},{"title":"List deals","description":"Returns the deals the member the key belongs to can read, most recently updated first, in the standard list envelope. Every filter narrows within that fence and ANDs with the others; `id` returns the readable deals among up to 100 ids, and a `brokerage` the key cannot read matches nothing. Page by passing `next_cursor` back as `cursor`. Requires the `deals:read` scope.","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/deals","href":"/api/reference/list-deals"},{"title":"Retrieve a deal","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/deals/{id}","href":"/api/reference/retrieve-a-deal"},{"title":"List events","description":"Every deal and task transition in transaction order, oldest first. Two changes to one subject can arrive out of commit order, so fetch the subject for its current state rather than replaying from/to. Poll forward from next_cursor; has_more false means caught up. Requires `events:read`, plus `tasks:read` for task events.","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/events","href":"/api/reference/list-events"},{"title":"List offices","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/offices","href":"/api/reference/list-offices"},{"title":"Retrieve an office","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/offices/{id}","href":"/api/reference/retrieve-an-office"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/tasks","href":"/api/reference/list-tasks"},{"title":"Retrieve a task","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/tasks/{id}","href":"/api/reference/retrieve-a-task"},{"title":"List users","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/users","href":"/api/reference/list-users"},{"title":"Retrieve a user","deprecated":null,"version":null,"openapi":"https://api.myabode.ca/v1/openapi.json get /v1/users/{id}","href":"/api/reference/retrieve-a-user"}]}]}]}]},"basePath":"","title":"Retrieve a deal - myAbode Deals Docs","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"]}