Returns the complete opportunity including stage, type, owner, intro person,
associated persons and companies, custom fields, days in current stage,
notes/files count, and activity dates. Returns 404 if the opportunity is
not visible in the tenant’s ring.
Each associated person/company carries city, state and country, so
an opportunity’s geography can be read off the record itself instead of
looking every association up individually.
GET
/
v1
/
opportunities
/
{opportunity_uuid}
Get a full opportunity record by UUID.
curl --request GET \ --url https://production-api.joinrings.com/v1/opportunities/{opportunity_uuid} \ --header 'x-api-key: <api-key>'
Set false to leave the deprecated custom_field_mapping schema off the response. Get it from GET /v1/opportunities/custom-fields instead. Defaults to true for backwards compatibility.
Extends OpportunityResponse with the tenant's custom-field schema,
which is only computed once per response here — list responses instead
carry it once at the top level (OpportunityListResponse.custom_field_mapping)
rather than repeating it on every item.
Deprecated: fetch the schema once from GET /v1/opportunities/custom-fields instead, and pass include_custom_field_mapping=false to leave it off this response. Each custom_fields entry already carries its field's name and type. Null when excluded.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rings AI","description":"Relationship intelligence for businesses that win on their networks. Build on Rings with the REST API or connect AI agents via MCP.","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/rings-ai/EVsJFZndjLtW_7WK/images/Group5.svg?fit=max\u0026auto=format\u0026n=EVsJFZndjLtW_7WK\u0026q=85\u0026s=bbbf7303b09ab9978ffaee9e90f250ec","dark":"https://mintcdn.com/rings-ai/EVsJFZndjLtW_7WK/images/Group5.svg?fit=max\u0026auto=format\u0026n=EVsJFZndjLtW_7WK\u0026q=85\u0026s=bbbf7303b09ab9978ffaee9e90f250ec"},"favicon":{"light":"https://mintcdn.com/rings-ai/EVsJFZndjLtW_7WK/images/icon-original.png?fit=max\u0026auto=format\u0026n=EVsJFZndjLtW_7WK\u0026q=85\u0026s=968ab65ef5c4793a38135dd4d6868876","dark":"https://mintcdn.com/rings-ai/EVsJFZndjLtW_7WK/images/icon-original.png?fit=max\u0026auto=format\u0026n=EVsJFZndjLtW_7WK\u0026q=85\u0026s=968ab65ef5c4793a38135dd4d6868876"},"api":{"openapi":"https://production-api.joinrings.com/openapi.json"},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"https://www.rings.ai","label":"Website"}],"primary":{"type":"button","label":"Get Started","href":"https://joinrings.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"schema":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rings-ai","hasAudioNarration":false,"actualSubdomain":"rings-ai","customDomains":["docs.rings.ai"],"gitSource":{"type":"github","owner":"rings-ai","repo":"rcp-data-pipeline","deployBranch":"main","contentDirectory":"mintlify_docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"f2baa2ef-5f3c-4fb9-b645-454aa43e6c38","liveDeploymentHistoryId":"6ae3521290bdcff7cbc3b51f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae3521290bdcff7cbc3b51f"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae3521290bdcff7cbc3b51f","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":77},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Opportunity","count":11},{"language":"default","tag":"MCP Guide","count":11},{"language":"default","tag":"Add the connector","count":10},{"language":"default","tag":"Note","count":9},{"language":"default","tag":"Person","count":9},{"language":"default","tag":"Activity","count":8},{"language":"default","tag":"Company","count":7},{"language":"default","tag":"Task","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/opportunity/get-opportunity","slug":"/api-reference/opportunity/get-opportunity","pageMetadata":{"title":"Get an opportunity","openapi":"GET /v1/opportunities/{opportunity_uuid}","description":"\nReturns the complete opportunity including stage, type, owner, intro person,\nassociated persons and companies, custom fields, days in current stage,\nnotes/files count, and activity dates. Returns 404 if the opportunity is\nnot visible in the tenant's ring.\n\nEach associated person/company carries `city`, `state` and `country`, so\nan opportunity's geography can be read off the record itself instead of\nlooking every association up individually.","href":"/api-reference/opportunity/get-opportunity"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns the complete opportunity including stage, type, owner, intro person,\\nassociated persons and companies, custom fields, days in current stage,\\nnotes/files count, and activity dates. Returns 404 if the opportunity is\\nnot visible in the tenant’s ring.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Each associated person/company carries \", _jsx(_components.code, {\n children: \"city\"\n }), \", \", _jsx(_components.code, {\n children: \"state\"\n }), \" and \", _jsx(_components.code, {\n children: \"country\"\n }), \", so\\nan opportunity’s geography can be read off the record itself instead of\\nlooking every association up individually.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get an opportunity","openapi":"GET /v1/opportunities/{opportunity_uuid}","description":"\nReturns the complete opportunity including stage, type, owner, intro person,\nassociated persons and companies, custom fields, days in current stage,\nnotes/files count, and activity dates. Returns 404 if the opportunity is\nnot visible in the tenant's ring.\n\nEach associated person/company carries `city`, `state` and `country`, so\nan opportunity's geography can be read off the record itself instead of\nlooking every association up individually.","href":"/api-reference/opportunity/get-opportunity"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"\nReturns the complete opportunity including stage, type, owner, intro person,\nassociated persons and companies, custom fields, days in current stage,\nnotes/files count, and activity dates. Returns 404 if the opportunity is\nnot visible in the tenant's ring.\n\nEach associated person/company carries `city`, `state` and `country`, so\nan opportunity's geography can be read off the record itself instead of\nlooking every association up individually.","operationId":"get_get_opportunity","parameters":["7b5b274e-6fa0-4534-9856-e62040d3db4e","6169c701-c130-4e89-a44e-0499f03c9fd7"],"responses":{"200":"306ec419-cac7-447f-a5cf-841ea60e55cd"},"summary":"Get a full opportunity record by UUID.","tags":["Opportunity"],"method":"get","type":"path","servers":["ac0c72ea-24cd-42c5-bf7e-af9869eeb624"],"security":["d3e1b4d8-8e73-42d2-8242-48f05e417bca"],"path":"/v1/opportunities/{opportunity_uuid}","baseUrlOptions":["https://production-api.joinrings.com"],"title":"Get a full opportunity record by UUID.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7b5b274e-6fa0-4534-9856-e62040d3db4e":{"in":"path","name":"opportunity_uuid","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"6169c701-c130-4e89-a44e-0499f03c9fd7":{"description":"Set false to leave the deprecated `custom_field_mapping` schema off the response. Get it from GET /v1/opportunities/custom-fields instead. Defaults to true for backwards compatibility.","in":"query","name":"include_custom_field_mapping","required":false,"schema":{"default":true,"title":"Include Custom Field Mapping","type":"boolean","isRequired":false,"description":"Set false to leave the deprecated `custom_field_mapping` schema off the response. Get it from GET /v1/opportunities/custom-fields instead. Defaults to true for backwards compatibility.","uniqueKey":"","typeLabel":"boolean"}}},"responses":{"306ec419-cac7-447f-a5cf-841ea60e55cd":{"content":{"application/json":{"schema":{"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"uuid","typeLabel":"string"},"associations":{"oneOf":[{"type":"array","items":{"properties":{"association_type":{"oneOf":[{"type":"string","title":"Association Type","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].association_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Association Type","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].association_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].association_type","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","title":"Context","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","title":"Context","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].created_at","typeLabel":"number | null"},"entity_type":{"enum":["PERSON","COMPANY","NOTE","FILE","TASK","ACTIVITY","OPPORTUNITY"],"title":"Entity Type","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].entity_type","typeLabel":"enum\u003cstring>"},"entity_uuid":{"title":"Entity Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].entity_uuid","typeLabel":"string"},"last_activity_date":{"oneOf":[{"type":"string","title":"Last Activity Date","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].last_activity_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].last_activity_date","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"number","title":"Updated At","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].updated_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Updated At","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].updated_at","typeLabel":"number | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].uuid","typeLabel":"string"},"activity":{"oneOf":[{"type":"object","title":"AssociatedActivity","required":["object_id","title","kind"],"properties":{"kind":{"oneOf":[{"type":"string","title":"Kind","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.kind.oneOf.0","typeLabel":"string"},{"type":"null","title":"Kind","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.kind.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.kind","typeLabel":"string | null"},"object_id":{"title":"Object Id","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.object_id","typeLabel":"string"},"title":{"oneOf":[{"type":"string","title":"Title","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.title","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","title":"End Date","uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.end_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"End Date","uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.end_date","typeLabel":"string | null"},"start_date":{"oneOf":[{"type":"string","title":"Start Date","uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.start_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Start Date","uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0.start_date","typeLabel":"string | null"}},"uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.0","typeLabel":"AssociatedActivity · object"},{"type":"null","uniqueKey":"associations.oneOf.0.items.[INDEX].activity.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].activity","typeLabel":"AssociatedActivity · object | null"},"company":{"oneOf":[{"type":"object","title":"AssociatedCompany","required":["uuid","name","logo_url","type","last_activity_date"],"properties":{"last_activity_date":{"oneOf":[{"type":"string","title":"Last Activity Date","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.last_activity_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.last_activity_date","typeLabel":"string | null"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.type","typeLabel":"string | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.uuid","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.country","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.0","typeLabel":"AssociatedCompany · object"},{"type":"null","uniqueKey":"associations.oneOf.0.items.[INDEX].company.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].company","typeLabel":"AssociatedCompany · object | null"},"opportunity":{"oneOf":[{"type":"object","title":"AssociatedOpportunity","required":["uuid","name","is_sub_opportunity"],"properties":{"is_sub_opportunity":{"title":"Is Sub Opportunity","type":"boolean","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.is_sub_opportunity","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","title":"Name","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.name","typeLabel":"string | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.uuid","typeLabel":"string"},"stage":{"oneOf":[{"type":"object","title":"OpportunityStageOnRecord","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.uuid","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0","typeLabel":"OpportunityStageOnRecord · object"},{"type":"null","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage","typeLabel":"OpportunityStageOnRecord · object | null"},"type":{"oneOf":[{"type":"object","title":"OpportunityTypeOnRecord","required":["uuid","label","label_plural","sub_label","sub_label_plural"],"properties":{"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.label","typeLabel":"string"},"label_plural":{"title":"Label Plural","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.label_plural","typeLabel":"string"},"sub_label":{"title":"Sub Label","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.sub_label","typeLabel":"string"},"sub_label_plural":{"title":"Sub Label Plural","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.sub_label_plural","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.uuid","typeLabel":"string"},"is_hidden":{"oneOf":[{"type":"boolean","title":"Is Hidden","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.is_hidden.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Hidden","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.is_hidden.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.is_hidden","typeLabel":"boolean | null"}},"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0","typeLabel":"OpportunityTypeOnRecord · object"},{"type":"null","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type","typeLabel":"OpportunityTypeOnRecord · object | null"}},"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.0","typeLabel":"AssociatedOpportunity · object"},{"type":"null","uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].opportunity","typeLabel":"AssociatedOpportunity · object | null"},"person":{"oneOf":[{"type":"object","title":"AssociatedPerson","required":["uuid","name","email","logo_url","type","last_activity_date"],"properties":{"email":{"oneOf":[{"type":"string","title":"Email","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.email","typeLabel":"string | null"},"last_activity_date":{"oneOf":[{"type":"string","title":"Last Activity Date","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.last_activity_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.last_activity_date","typeLabel":"string | null"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.type","typeLabel":"string | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.uuid","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.country","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.0","typeLabel":"AssociatedPerson · object"},{"type":"null","uniqueKey":"associations.oneOf.0.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations.oneOf.0.items.[INDEX].person","typeLabel":"AssociatedPerson · object | null"}},"required":["uuid","entity_uuid","entity_type","association_type","context","last_activity_date","created_at","updated_at"],"title":"OpportunityAssociation","type":"object","uniqueKey":"associations.oneOf.0.items.[INDEX]","typeLabel":"OpportunityAssociation · object"},"title":"Associations","uniqueKey":"associations.oneOf.0","typeLabel":"OpportunityAssociation · object[]"},{"type":"null","title":"Associations","uniqueKey":"associations.oneOf.1","typeLabel":"null"}],"uniqueKey":"associations","typeLabel":"OpportunityAssociation · object[] | null"},"children_metadata":{"oneOf":[{"type":"object","title":"OpportunityMetadata","required":["count","weighted_value_sum","value_sum","probability_sum"],"properties":{"count":{"title":"Count","type":"integer","isRequired":true,"uniqueKey":"children_metadata.oneOf.0.count","typeLabel":"integer"},"probability_sum":{"title":"Probability Sum","type":"integer","isRequired":true,"uniqueKey":"children_metadata.oneOf.0.probability_sum","typeLabel":"integer"},"value_sum":{"title":"Value Sum","type":"integer","isRequired":true,"uniqueKey":"children_metadata.oneOf.0.value_sum","typeLabel":"integer"},"weighted_value_sum":{"title":"Weighted Value Sum","type":"integer","isRequired":true,"uniqueKey":"children_metadata.oneOf.0.weighted_value_sum","typeLabel":"integer"}},"uniqueKey":"children_metadata.oneOf.0","typeLabel":"OpportunityMetadata · object"},{"type":"null","uniqueKey":"children_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"children_metadata","typeLabel":"OpportunityMetadata · object | null"},"close_date":{"oneOf":[{"type":"string","title":"Close Date","uniqueKey":"close_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Close Date","uniqueKey":"close_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"close_date","typeLabel":"string | null"},"company_last_activity_date":{"oneOf":[{"type":"string","title":"Company Last Activity Date","uniqueKey":"company_last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Last Activity Date","uniqueKey":"company_last_activity_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"company_last_activity_date","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","uniqueKey":"created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"number | null"},"created_by":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"created_by.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"created_by.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"created_by.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"created_by.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"created_by.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"created_by.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"created_by.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"created_by.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by","typeLabel":"RelatedPerson · object | null"},"custom_field_mapping":{"oneOf":[{"type":"object","title":"CustomFieldMapping","description":"Deprecated: fetch the schema once from GET /v1/opportunities/custom-fields instead, and pass `include_custom_field_mapping=false` to leave it off this response. Each `custom_fields` entry already carries its field's `name` and `type`. Null when excluded.","required":["fields"],"deprecated":true,"properties":{"fields":{"items":{"properties":{"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].key","typeLabel":"string"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].name","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].type","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].uuid","typeLabel":"string"},"choices":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].choices.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Choices","uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].choices.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Choices","uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].choices.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX].choices","typeLabel":"string[] | null"}},"required":["uuid","key","name","type"],"title":"CustomFieldDefinition","type":"object","uniqueKey":"custom_field_mapping.oneOf.0.fields.items.[INDEX]","typeLabel":"CustomFieldDefinition · object"},"title":"Fields","type":"array","isRequired":true,"uniqueKey":"custom_field_mapping.oneOf.0.fields","typeLabel":"CustomFieldDefinition · object[]"},"standard_key_to_uuid":{"oneOf":[{"type":"object","title":"Standard Key To Uuid","additionalProperties":{"type":"string","uniqueKey":"custom_field_mapping.oneOf.0.standard_key_to_uuid.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"custom_field_mapping.oneOf.0.standard_key_to_uuid.oneOf.0","typeLabel":"Standard Key To Uuid · object"},{"type":"null","title":"Standard Key To Uuid","uniqueKey":"custom_field_mapping.oneOf.0.standard_key_to_uuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_field_mapping.oneOf.0.standard_key_to_uuid","typeLabel":"Standard Key To Uuid · object | null"},"unresolved_keys":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"custom_field_mapping.oneOf.0.unresolved_keys.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Unresolved Keys","uniqueKey":"custom_field_mapping.oneOf.0.unresolved_keys.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Unresolved Keys","uniqueKey":"custom_field_mapping.oneOf.0.unresolved_keys.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_field_mapping.oneOf.0.unresolved_keys","typeLabel":"string[] | null"}},"uniqueKey":"custom_field_mapping.oneOf.0","typeLabel":"CustomFieldMapping · object"},{"type":"null","description":"Deprecated: fetch the schema once from GET /v1/opportunities/custom-fields instead, and pass `include_custom_field_mapping=false` to leave it off this response. Each `custom_fields` entry already carries its field's `name` and `type`. Null when excluded.","deprecated":true,"uniqueKey":"custom_field_mapping.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_field_mapping","typeLabel":"CustomFieldMapping · object | null"},"custom_fields":{"items":{"properties":{"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].key","typeLabel":"string"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].name","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].type","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].uuid","typeLabel":"string"},"float_value":{"oneOf":[{"type":"number","title":"Float Value","uniqueKey":"custom_fields.items.[INDEX].float_value.oneOf.0","typeLabel":"number"},{"type":"null","title":"Float Value","uniqueKey":"custom_fields.items.[INDEX].float_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].float_value","typeLabel":"number | null"},"string_value":{"oneOf":[{"type":"string","title":"String Value","uniqueKey":"custom_fields.items.[INDEX].string_value.oneOf.0","typeLabel":"string"},{"type":"null","title":"String Value","uniqueKey":"custom_fields.items.[INDEX].string_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"custom_fields.items.[INDEX].string_value","typeLabel":"string | null"}},"required":["uuid","key","name","type"],"title":"OpportunityCustomFieldValue","type":"object","uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"OpportunityCustomFieldValue · object"},"title":"Custom Fields","type":"array","uniqueKey":"custom_fields","typeLabel":"OpportunityCustomFieldValue · object[]"},"days_in_stage":{"oneOf":[{"type":"integer","title":"Days In Stage","uniqueKey":"days_in_stage.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Days In Stage","uniqueKey":"days_in_stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"days_in_stage","typeLabel":"integer | null"},"details":{"oneOf":[{"type":"string","title":"Details","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | null"},"intro_date":{"oneOf":[{"type":"string","title":"Intro Date","uniqueKey":"intro_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Intro Date","uniqueKey":"intro_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"intro_date","typeLabel":"string | null"},"intro_person":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"intro_person.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"intro_person.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"intro_person.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"intro_person.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"intro_person.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"intro_person.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"intro_person.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"intro_person.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"intro_person.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"intro_person.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"intro_person.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"intro_person.oneOf.1","typeLabel":"null"}],"uniqueKey":"intro_person","typeLabel":"RelatedPerson · object | null"},"last_activity_date":{"oneOf":[{"type":"string","title":"Last Activity Date","uniqueKey":"last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","uniqueKey":"last_activity_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_activity_date","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"next_meeting_at":{"oneOf":[{"type":"string","title":"Next Meeting At","uniqueKey":"next_meeting_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Meeting At","uniqueKey":"next_meeting_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_meeting_at","typeLabel":"string | null"},"next_step":{"oneOf":[{"type":"string","title":"Next Step","uniqueKey":"next_step.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Step","uniqueKey":"next_step.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_step","typeLabel":"string | null"},"notes_and_files_count":{"oneOf":[{"type":"integer","title":"Notes And Files Count","uniqueKey":"notes_and_files_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Notes And Files Count","uniqueKey":"notes_and_files_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"notes_and_files_count","typeLabel":"integer | null"},"owner":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"owner.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"owner.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"owner.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"owner.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"owner.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"owner.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"owner.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"owner.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"owner","typeLabel":"RelatedPerson · object | null"},"parent_name":{"oneOf":[{"type":"string","title":"Parent Name","uniqueKey":"parent_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Name","uniqueKey":"parent_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_name","typeLabel":"string | null"},"parent_uuid":{"oneOf":[{"type":"string","title":"Parent Uuid","uniqueKey":"parent_uuid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Uuid","uniqueKey":"parent_uuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"parent_uuid","typeLabel":"string | null"},"person_last_activity_date":{"oneOf":[{"type":"string","title":"Person Last Activity Date","uniqueKey":"person_last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Person Last Activity Date","uniqueKey":"person_last_activity_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"person_last_activity_date","typeLabel":"string | null"},"probability":{"oneOf":[{"type":"integer","title":"Probability","uniqueKey":"probability.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Probability","uniqueKey":"probability.oneOf.1","typeLabel":"null"}],"uniqueKey":"probability","typeLabel":"integer | null"},"source_date":{"oneOf":[{"type":"string","title":"Source Date","uniqueKey":"source_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source Date","uniqueKey":"source_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"source_date","typeLabel":"string | null"},"stage":{"oneOf":[{"type":"object","title":"OpportunityStageOnRecord","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"stage.oneOf.0.uuid","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"stage.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"stage.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"stage.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"stage.oneOf.0","typeLabel":"OpportunityStageOnRecord · object"},{"type":"null","uniqueKey":"stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"stage","typeLabel":"OpportunityStageOnRecord · object | null"},"type":{"oneOf":[{"type":"object","title":"OpportunityTypeOnRecord","required":["uuid","label","label_plural","sub_label","sub_label_plural"],"properties":{"label":{"title":"Label","type":"string","isRequired":true,"uniqueKey":"type.oneOf.0.label","typeLabel":"string"},"label_plural":{"title":"Label Plural","type":"string","isRequired":true,"uniqueKey":"type.oneOf.0.label_plural","typeLabel":"string"},"sub_label":{"title":"Sub Label","type":"string","isRequired":true,"uniqueKey":"type.oneOf.0.sub_label","typeLabel":"string"},"sub_label_plural":{"title":"Sub Label Plural","type":"string","isRequired":true,"uniqueKey":"type.oneOf.0.sub_label_plural","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"type.oneOf.0.uuid","typeLabel":"string"},"is_hidden":{"oneOf":[{"type":"boolean","title":"Is Hidden","uniqueKey":"type.oneOf.0.is_hidden.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Hidden","uniqueKey":"type.oneOf.0.is_hidden.oneOf.1","typeLabel":"null"}],"uniqueKey":"type.oneOf.0.is_hidden","typeLabel":"boolean | null"}},"uniqueKey":"type.oneOf.0","typeLabel":"OpportunityTypeOnRecord · object"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"OpportunityTypeOnRecord · object | null"},"updated_at":{"oneOf":[{"type":"number","title":"Updated At","uniqueKey":"updated_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Updated At","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"number | null"},"updated_by":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"updated_by.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"updated_by.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"updated_by.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_by.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"updated_by.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"updated_by.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_by.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"updated_by.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"updated_by.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_by.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"updated_by.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"updated_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_by","typeLabel":"RelatedPerson · object | null"},"value":{"oneOf":[{"type":"integer","title":"Value","uniqueKey":"value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","uniqueKey":"value.oneOf.1","typeLabel":"null"}],"uniqueKey":"value","typeLabel":"integer | null"},"weighted_value":{"oneOf":[{"type":"integer","title":"Weighted Value","uniqueKey":"weighted_value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Weighted Value","uniqueKey":"weighted_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"weighted_value","typeLabel":"integer | null"}},"required":["uuid"],"title":"OpportunityDetailResponse","type":"object","uniqueKey":"","typeLabel":"OpportunityDetailResponse · object"},"examples":{"Example":{"title":"Example","value":{"uuid":"\u003cstring>","associations":[{"association_type":"\u003cstring>","context":"\u003cstring>","created_at":123,"entity_type":"PERSON","entity_uuid":"\u003cstring>","last_activity_date":"\u003cstring>","updated_at":123,"uuid":"\u003cstring>","activity":{"kind":"\u003cstring>","object_id":"\u003cstring>","title":"\u003cstring>","end_date":"\u003cstring>","start_date":"\u003cstring>"},"company":{"last_activity_date":"\u003cstring>","logo_url":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","uuid":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","state":"\u003cstring>"},"opportunity":{"is_sub_opportunity":true,"name":"\u003cstring>","uuid":"\u003cstring>","stage":{"uuid":"\u003cstring>","name":"\u003cstring>"},"type":{"label":"\u003cstring>","label_plural":"\u003cstring>","sub_label":"\u003cstring>","sub_label_plural":"\u003cstring>","uuid":"\u003cstring>","is_hidden":true}},"person":{"email":"\u003cstring>","last_activity_date":"\u003cstring>","logo_url":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","uuid":"\u003cstring>","city":"\u003cstring>","country":"\u003cstring>","state":"\u003cstring>"}}],"children_metadata":{"count":123,"probability_sum":123,"value_sum":123,"weighted_value_sum":123},"close_date":"\u003cstring>","company_last_activity_date":"\u003cstring>","created_at":123,"created_by":{"uuid":"\u003cstring>","logo_url":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>"},"custom_field_mapping":{"fields":[{"key":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","uuid":"\u003cstring>","choices":["\u003cstring>"]}],"standard_key_to_uuid":{},"unresolved_keys":["\u003cstring>"]},"custom_fields":[{"key":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","uuid":"\u003cstring>","float_value":123,"string_value":"\u003cstring>"}],"days_in_stage":123,"details":"\u003cstring>","intro_date":"\u003cstring>","intro_person":{"uuid":"\u003cstring>","logo_url":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>"},"last_activity_date":"\u003cstring>","name":"\u003cstring>","next_meeting_at":"\u003cstring>","next_step":"\u003cstring>","notes_and_files_count":123,"owner":{"uuid":"\u003cstring>","logo_url":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>"},"parent_name":"\u003cstring>","parent_uuid":"\u003cstring>","person_last_activity_date":"\u003cstring>","probability":123,"source_date":"\u003cstring>","stage":{"uuid":"\u003cstring>","name":"\u003cstring>"},"type":{"label":"\u003cstring>","label_plural":"\u003cstring>","sub_label":"\u003cstring>","sub_label_plural":"\u003cstring>","uuid":"\u003cstring>","is_hidden":true},"updated_at":123,"updated_by":{"uuid":"\u003cstring>","logo_url":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>"},"value":123,"weighted_value":123}}},"exampleType":"generated"}},"description":"Single-opportunity response (`GET /v1/opportunities/{uuid}`).\n\nExtends `OpportunityResponse` with the tenant's custom-field schema,\nwhich is only computed once per response here — list responses instead\ncarry it once at the top level (`OpportunityListResponse.custom_field_mapping`)\nrather than repeating it on every item.","exampleType":"generated"}},"security":{"d3e1b4d8-8e73-42d2-8242-48f05e417bca":{"ApiKeyAuth":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"ac0c72ea-24cd-42c5-bf7e-af9869eeb624":{"description":"API server","url":"https://production-api.joinrings.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"in":"header","name":"x-api-key","type":"apiKey","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"https://production-api.joinrings.com/openapi.json"},"subdomain":"rings-ai","siteName":"Rings AI","title":"Get an opportunity - Rings AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-10T07:57:56.039Z","originalFileLocation":"api-reference/opportunity/get-opportunity.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 complete opportunity including stage, type, owner, intro person, associated persons and companies, custom fields, days in current stage, notes/files count, and activity dates. Returns 404 if the opportunity is not visible in the tenant\u0026#x27;s ring. Each associated person/company carries city, state and country, so an opportunity\u0026#x27;s geography can be read off the record itself instead of looking every association up individually.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rings AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_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/rings-ai/_zk5vOoQ8ix_XOCm/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an opportunity - Rings AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the complete opportunity including stage, type, owner, intro person, associated persons and companies, custom fields, days in current stage, notes/files count, and activity dates. Returns 404 if the opportunity is not visible in the tenant\u0026#x27;s ring. Each associated person/company carries city, state and country, so an opportunity\u0026#x27;s geography can be read off the record itself instead of looking every association up individually.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rings AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rings.ai/api-reference/opportunity/get-opportunity\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rings-ai.mintlify.app/_mintlify/api/og/v2?division=Opportunity\u0026amp;title=Get+an+opportunity\u0026amp;description=%0AReturns+the+complete+opportunity+including+stage%2C+type%2C+owner%2C+intro+person%2C%0Aassociated+persons+and+companies%2C+custom+fields%2C+days+in+current+stage%2C%0Anotes%2Ffile\u0026amp;theme=2e1657476a2935937e03de5f\u0026amp;signature=61f17b0e938125ec9fcbb01c6163e6fdeb420fa262150213f298d8f1745322d8\">\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 an opportunity - Rings AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the complete opportunity including stage, type, owner, intro person, associated persons and companies, custom fields, days in current stage, notes/files count, and activity dates. Returns 404 if the opportunity is not visible in the tenant\u0026#x27;s ring. Each associated person/company carries city, state and country, so an opportunity\u0026#x27;s geography can be read off the record itself instead of looking every association up individually.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rings-ai.mintlify.app/_mintlify/api/og/v2?division=Opportunity\u0026amp;title=Get+an+opportunity\u0026amp;description=%0AReturns+the+complete+opportunity+including+stage%2C+type%2C+owner%2C+intro+person%2C%0Aassociated+persons+and+companies%2C+custom+fields%2C+days+in+current+stage%2C%0Anotes%2Ffile\u0026amp;theme=2e1657476a2935937e03de5f\u0026amp;signature=61f17b0e938125ec9fcbb01c6163e6fdeb420fa262150213f298d8f1745322d8\">\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/rings-ai/_zk5vOoQ8ix_XOCm/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rings AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rings.ai/api-reference/opportunity/get-opportunity\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/opportunity/get-opportunity.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rings.ai/#organization\",\"name\":\"Rings AI\",\"url\":\"https://docs.rings.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rings-ai/EVsJFZndjLtW_7WK/images/Group5.svg?fit=max\u0026auto=format\u0026n=EVsJFZndjLtW_7WK\u0026q=85\u0026s=bbbf7303b09ab9978ffaee9e90f250ec\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rings.ai#website\",\"name\":\"Rings AI\",\"url\":\"https://docs.rings.ai\",\"publisher\":{\"@id\":\"https://docs.rings.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity#webpage\",\"url\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity\",\"name\":\"Get an opportunity\",\"description\":\"Returns the complete opportunity including stage, type, owner, intro person, associated persons and companies, custom fields, days in current stage, notes/files count, and activity dates. Returns 404 if the opportunity is not visible in the tenant's ring. Each associated person/company carries city, state and country, so an opportunity's geography can be read off the record itself instead of looking every association up individually.\",\"dateModified\":\"2026-09-10T07:57:56.039Z\",\"isPartOf\":{\"@id\":\"https://docs.rings.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Opportunity\",\"item\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an opportunity\",\"item\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity#apireference\",\"headline\":\"Get an opportunity\",\"name\":\"Get an opportunity\",\"description\":\"Returns the complete opportunity including stage, type, owner, intro person, associated persons and companies, custom fields, days in current stage, notes/files count, and activity dates. Returns 404 if the opportunity is not visible in the tenant's ring. Each associated person/company carries city, state and country, so an opportunity's geography can be read off the record itself instead of looking every association up individually.\",\"url\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rings.ai/api-reference/opportunity/get-opportunity#webpage\"},\"dateModified\":\"2026-09-10T07:57:56.039Z\",\"publisher\":{\"@id\":\"https://docs.rings.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rings.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rings AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rings AI","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Overview","href":"/api-reference/introduction"}]},{"group":"Person","pages":[{"title":"List persons","openapi":"GET /v1/persons","href":"/api-reference/person/list-persons"},{"title":"List person custom fields","openapi":"GET /v1/persons/custom-fields","href":"/api-reference/person/list-custom-fields"},{"title":"Create a person","openapi":"POST /v1/persons","href":"/api-reference/person/create-person"},{"title":"Batch create persons","openapi":"POST /v1/persons/batch","href":"/api-reference/person/batch-create"},{"title":"Lookup a person","openapi":"GET /v1/persons/lookup","href":"/api-reference/person/lookup"},{"title":"Batch lookup persons","openapi":"POST /v1/persons/lookup/batch","href":"/api-reference/person/lookup-batch"},{"title":"Get a person","openapi":"GET /v1/persons/{person_uuid}","href":"/api-reference/person/get-person"},{"title":"Update a person","openapi":"PUT /v1/persons/{person_uuid}","href":"/api-reference/person/update-person"},{"title":"Merge persons","openapi":"POST /v1/persons/{person_uuid}/merge","href":"/api-reference/person/merge-person"}]},{"group":"Company","pages":[{"title":"List companies","openapi":"GET /v1/companies","href":"/api-reference/company/list-companies"},{"title":"Create a company","openapi":"POST /v1/companies","href":"/api-reference/company/create-company"},{"title":"Lookup a company","openapi":"GET /v1/companies/lookup","href":"/api-reference/company/lookup"},{"title":"Get a company","openapi":"GET /v1/companies/{company_uuid}","href":"/api-reference/company/get-company"},{"title":"List company employees","openapi":"GET /v1/companies/{company_uuid}/employees","href":"/api-reference/company/list-employees"},{"title":"Update a company","openapi":"PUT /v1/companies/{company_uuid}","href":"/api-reference/company/update-company"},{"title":"Batch lookup companies","openapi":"POST /v1/companies/lookup/batch","href":"/api-reference/company/lookup-batch"}]},{"group":"Opportunity","pages":[{"title":"List opportunities","openapi":"GET /v1/opportunities","href":"/api-reference/opportunity/list-opportunities"},{"title":"Create an opportunity","openapi":"POST /v1/opportunities","description":"\nRequired fields: name, type_uuid, stage_uuid. If the user hasn't specified\nan opportunity type or stage, ask them before calling this endpoint.\n\nTo discover valid IDs, first call GET /v1/opportunity-types to choose a\ntype_uuid (and inspect its pinning_config to learn whether a person/company\nassociation is required), then call\nGET /v1/opportunity-types/{type_uuid}/stages to choose a stage_uuid for that\ntype. A stage_uuid is only valid for the type_uuid it belongs to.\n\nOptional: details, value, probability, source_date, intro_date, close_date,\nintro_person_uuid, owner_user_uuid, associations (to link persons/companies).\nowner_user_uuid takes a user uuid from GET /v1/users; the person uuid an\nexisting opportunity reports under `owner` is accepted too. Defaults to the\ncalling user. An owner that resolves to neither returns 400.\nReturns the new opportunity UUID and timestamps on success (201).","href":"/api-reference/opportunity/create-opportunity"},{"title":"Get an opportunity","openapi":"GET /v1/opportunities/{opportunity_uuid}","href":"/api-reference/opportunity/get-opportunity"},{"title":"Update an opportunity","openapi":"PUT /v1/opportunities/{opportunity_uuid}","description":"\nOnly fields present in the request body are written; other attributes\non the existing record are preserved. Association edits go through\nthe dedicated associations sub-resource (see below). Returns 404 if\nthe opportunity is not visible under the tenant's ring, and 400 if a\nfield value is rejected (e.g. an owner_user_uuid matching no user).","href":"/api-reference/opportunity/update-opportunity"},{"title":"Delete opportunities","openapi":"DELETE /v1/opportunities","href":"/api-reference/opportunity/delete-opportunities"},{"title":"Add opportunity association","openapi":"POST /v1/opportunities/{opportunity_uuid}/associations","href":"/api-reference/opportunity/add-association"},{"title":"Delete opportunity association","openapi":"DELETE /v1/opportunities/{opportunity_uuid}/associations/{association_uuid}","href":"/api-reference/opportunity/delete-association"},{"title":"List opportunity types","openapi":"GET /v1/opportunity-types","href":"/api-reference/opportunity/list-types"},{"title":"List opportunity stages","openapi":"GET /v1/opportunity-types/{type_uuid}/stages","href":"/api-reference/opportunity/list-stages"},{"title":"List opportunities for a company","openapi":"GET /v1/companies/{company_uuid}/opportunities","href":"/api-reference/opportunity/list-by-company"},{"title":"List opportunities for a person","openapi":"GET /v1/persons/{person_uuid}/opportunities","href":"/api-reference/opportunity/list-by-person"}]},{"group":"Activity","pages":[{"title":"Get activity body","openapi":"GET /v1/activities/{activity_object_id}/body","href":"/api-reference/activity/get-body"},{"title":"Get activity thread","openapi":"GET /v1/activities/{activity_object_id}/thread","href":"/api-reference/activity/get-thread"},{"title":"Company activities","openapi":"GET /v1/companies/{company_uuid}/activities","href":"/api-reference/activity/company-activities"},{"title":"Company activity stats","openapi":"GET /v1/companies/{company_uuid}/activity-stats","href":"/api-reference/activity/company-activity-stats"},{"title":"Bulk company activity stats","openapi":"POST /v1/companies/activity-stats/batch","href":"/api-reference/activity/company-activity-stats-batch"},{"title":"Person activities","openapi":"GET /v1/persons/{person_uuid}/activities","href":"/api-reference/activity/person-activities"},{"title":"Person activity stats","openapi":"GET /v1/persons/{person_uuid}/activity-stats","href":"/api-reference/activity/person-activity-stats"},{"title":"Bulk person activity stats","openapi":"POST /v1/persons/activity-stats/batch","href":"/api-reference/activity/person-activity-stats-batch"}]},{"group":"Meetings","pages":[{"title":"List meetings","openapi":"GET /v1/meetings","href":"/api-reference/meetings/list-meetings"},{"title":"Get a meeting","openapi":"GET /v1/meetings/{activity_id}","href":"/api-reference/meetings/get-meeting"}]},{"group":"Note","pages":[{"title":"List notes","openapi":"GET /v1/notes","href":"/api-reference/note/list-notes"},{"title":"Create a note","openapi":"POST /v1/notes","href":"/api-reference/note/create-note"},{"title":"Batch create notes","openapi":"POST /v1/notes/batch","href":"/api-reference/note/batch-create"},{"title":"Search notes","openapi":"POST /v1/notes/search","href":"/api-reference/note/search"},{"title":"Get a note","openapi":"GET /v1/notes/{note_uuid}","href":"/api-reference/note/get-note"},{"title":"Update a note","openapi":"PUT /v1/notes/{note_uuid}","href":"/api-reference/note/update-note"},{"title":"Delete a note","openapi":"DELETE /v1/notes/{note_uuid}","href":"/api-reference/note/delete-note"},{"title":"Add note association","openapi":"POST /v1/notes/{note_uuid}/associations","href":"/api-reference/note/add-association"},{"title":"Delete note association","openapi":"DELETE /v1/notes/{note_uuid}/associations/{association_uuid}","href":"/api-reference/note/delete-association"}]},{"group":"Task","pages":[{"title":"List tasks","openapi":"GET /v1/tasks","href":"/api-reference/task/list-tasks"},{"title":"Create a task","openapi":"POST /v1/tasks","href":"/api-reference/task/create-task"},{"title":"Get a task","openapi":"GET /v1/tasks/{task_id}","href":"/api-reference/task/get-task"},{"title":"Update a task","openapi":"PUT /v1/tasks/{task_id}","href":"/api-reference/task/update-task"},{"title":"Delete a task","openapi":"DELETE /v1/tasks/{task_id}","href":"/api-reference/task/delete-task"},{"title":"Add task association","openapi":"POST /v1/tasks/{task_id}/associations","href":"/api-reference/task/add-association"},{"title":"Delete task association","openapi":"DELETE /v1/tasks/{task_id}/associations/{association_uuid}","href":"/api-reference/task/delete-association"}]},{"group":"Recommended Paths","pages":[{"title":"Recommended paths to a person","openapi":"GET /v1/persons/{person_uuid}/recommended-paths","href":"/api-reference/recommended-paths/person"},{"title":"Recommended paths to a company","openapi":"GET /v1/companies/{company_uuid}/recommended-paths","href":"/api-reference/recommended-paths/company"},{"title":"Bulk recommended paths (persons)","openapi":"POST /v1/persons/recommended-paths/batch","href":"/api-reference/recommended-paths/person-batch"},{"title":"Bulk recommended paths (companies)","openapi":"POST /v1/companies/recommended-paths/batch","href":"/api-reference/recommended-paths/company-batch"}]},{"group":"PathPower","pages":[{"title":"Bulk PathPower scores","openapi":"GET /v1/pathpower/scores","href":"/api-reference/pathpower/bulk-scores"},{"title":"PathPower for a person","openapi":"GET /v1/persons/{person_uuid}/pathpower","href":"/api-reference/pathpower/person"},{"title":"PathPower for a company","openapi":"GET /v1/companies/{company_uuid}/pathpower","href":"/api-reference/pathpower/company"}]},{"group":"Relationships","pages":[{"title":"List ring relationships","openapi":"GET /v1/relationships","href":"/api-reference/relationships/ring"},{"title":"My relationships","openapi":"GET /v1/relationships/mine","href":"/api-reference/relationships/mine"}]},{"group":"Intro","pages":[{"title":"List intros","openapi":"GET /v1/intros","href":"/api-reference/intro/list-intros"},{"title":"Log intro","openapi":"POST /v1/intros","href":"/api-reference/intro/log-intro"},{"title":"Update intro","openapi":"PUT /v1/intros/{intro_uuid}","href":"/api-reference/intro/update-intro"},{"title":"Delete intro","openapi":"DELETE /v1/intros/{intro_uuid}","href":"/api-reference/intro/delete-intro"},{"title":"List intro options","openapi":"GET /v1/intros/options","href":"/api-reference/intro/list-options"},{"title":"Get intro insights","openapi":"GET /v1/intros/insights","href":"/api-reference/intro/insights"}]},{"group":"AI Summary","pages":[{"title":"AI summary for a person","openapi":"GET /v1/persons/{person_uuid}/ai-summary","href":"/api-reference/ai-summary/person"},{"title":"AI summary for a company","openapi":"GET /v1/companies/{company_uuid}/ai-summary","href":"/api-reference/ai-summary/company"}]},{"group":"Entity Lists","pages":[{"title":"List entity lists","openapi":"GET /v1/lists","href":"/api-reference/lists/list-lists"},{"title":"List entity list members","openapi":"GET /v1/lists/{list_uuid}/entities","href":"/api-reference/lists/list-entities"},{"title":"Create an entity list","openapi":"POST /v1/lists","href":"/api-reference/lists/create-list"},{"title":"Update an entity list","openapi":"PUT /v1/lists/{list_uuid}","href":"/api-reference/lists/update-list"}]},{"group":"Users","pages":[{"title":"Get current user","openapi":"GET /v1/me","href":"/api-reference/users/me"},{"title":"List users","openapi":"GET /v1/users","href":"/api-reference/users/list-users"}]}]}]},"title":"Get an opportunity - Rings AI","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}