Returns a paginated list of opportunities visible to the tenant ring.
Filter parameters (all optional):
name: Case-insensitive substring match on the opportunity’s own name
search: Search name and associated person/company names. All words must
match, in any order; falls back to fuzzy matching when nothing does.
Does not search the opportunity type label
opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type
name, including a sub-label, with GET /v1/opportunity-types
opportunity_stage_uuid: Filter by a single stage UUID
opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage
names aren’t accepted; the parameter description explains how to
resolve one, including names shared by several stages
owner_user_uuid: Comma-separated owner UUID(s); accepts either a user
UUID or the person UUID shown as owner.uuid on a record. Returns 400
if none of them resolve to a user in this tenant
include_no_owner: Widens owner_user_uuid to also match opportunities with
no owner; no effect unless owner_user_uuid is set
has_owner: true for only owned opportunities, false for only unassigned
ones; omit for both
intro_person_uuid: Filter by the intro person’s UUID
related_company_uuid / related_person_uuid: parent opportunities that have a
sub-opportunity associated with this entity
parent_uuid: Return only sub-opportunities of this parent UUID
hierarchy_type: ‘PARENT’ or ‘CHILD’ (ignored if parent_uuid is set)
company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities
associated with any of them
city / state / country: Where an associated person or company is based —
this is how you answer “which of my deals are in LA”. They AND together
and must all match the same associated entity. Spell the state out
(‘Florida’), or pass a two-letter code with country (‘FL’ + ‘US’); a
code alone returns 400, since unscoped ‘FL’ resolves to Flintshire, GB
value_from / value_to, probability_from / probability_to: inclusive range filters
updated_after / updated_before: ISO 8601 date/datetime range on updated_at
source_date_from / source_date_to: ISO 8601 dates, required together
close_date_from / close_date_to: ISO 8601 dates, required together; opportunities
with no close_date are excluded
last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required
together
next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required
together; an associated person or company has its next meeting in range
include_no_next_meeting: true for only opportunities with no meeting
scheduled with any associated person or company; overrides
next_meeting_at_from / next_meeting_at_to
days_in_stage_from / days_in_stage_to: inclusive range on days since the
most recent stage change; either end may be omitted
Opaque cursor from a previous response's next_cursor. When supplied, the page starts immediately after the last record of that response and page is ignored — unlike page, this cannot skip or repeat records when the data changes mid-scan. Filters and sort must stay identical for the whole scan; changing one is a 400. Not supported by every list endpoint — those that support it return next_cursor.
Comma-separated list of opportunity stage UUIDs (IN filter, e.g. for 'Diligence or later'). Stage names aren't accepted. Resolve one with GET /v1/opportunity-types/{type_uuid}/stages, or GET /v1/opportunities/grouped?group_by=STAGE when the type is unknown (group_label is the name, group_key the UUID). This lookup omits stages with no opportunities. A name can belong to several stages, so pass every matching UUID.
Search the opportunity name and its associated person/company names. Every whitespace-separated word must appear, in any order. If nothing matches, retries fuzzily so near-misses and typos still return results rather than an empty page, closest match first unless sort_by is given. Broader than name, which only matches the opportunity's own name field. Does not search the opportunity type label.
Comma-separated owner UUID(s); filters by the opportunity owner. Accepts either a user UUID or the person UUID shown as owner.uuid on a record. Returns 400 if none resolve.
Widens owner_user_uuid to also match opportunities with no owner. Has no effect on its own -- unowned opportunities are already returned when no owner filter is set.
Case-insensitive substring on the city of an associated person or company (e.g. 'Los Angeles'). Pass the full city name, not an abbreviation — 'LA' is matched as a substring and hits Dallas and Cleveland, not Los Angeles. Prefer this over paging the list and filtering client-side.
State/region of an associated person or company. A full name ('Florida') works on its own; a two-letter code ('FL', 'NY') is ISO 3166-2 and requires country, since unscoped 'FL' means Flintshire, GB. Returns 400 if it does not resolve.
ISO 8601 datetime. Must be paired with next_meeting_at_to — both are required together. Matches opportunities where an associated person or company has its next meeting in this window. Ignored when include_no_next_meeting=true.
true returns only opportunities with no meeting scheduled — none of their associated people or companies has an upcoming meeting. Omit (or false) to apply no meeting filter.
Minimum days since the opportunity's most recent stage change, inclusive — e.g. 30 for deals stuck a month or more. Opportunities with no recorded stage change are excluded.
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.
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/list-opportunities","slug":"/api-reference/opportunity/list-opportunities","pageMetadata":{"title":"List opportunities","openapi":"GET /v1/opportunities","description":"\nReturns a paginated list of opportunities visible to the tenant ring.\n\nFilter parameters (all optional):\n- name: Case-insensitive substring match on the opportunity's own name\n- search: Search name and associated person/company names. All words must\n match, in any order; falls back to fuzzy matching when nothing does.\n Does not search the opportunity type label\n- opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type\n name, including a sub-label, with GET /v1/opportunity-types\n- opportunity_stage_uuid: Filter by a single stage UUID\n- opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage\n names aren't accepted; the parameter description explains how to\n resolve one, including names shared by several stages\n- owner_user_uuid: Comma-separated owner UUID(s); accepts either a user\n UUID or the person UUID shown as `owner.uuid` on a record. Returns 400\n if none of them resolve to a user in this tenant\n- include_no_owner: Widens owner_user_uuid to also match opportunities with\n no owner; no effect unless owner_user_uuid is set\n- has_owner: true for only owned opportunities, false for only unassigned\n ones; omit for both\n- intro_person_uuid: Filter by the intro person's UUID\n- related_company_uuid / related_person_uuid: parent opportunities that have a\n sub-opportunity associated with this entity\n- parent_uuid: Return only sub-opportunities of this parent UUID\n- hierarchy_type: 'PARENT' or 'CHILD' (ignored if parent_uuid is set)\n- company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities\n associated with any of them\n- city / state / country: Where an associated person or company is based —\n this is how you answer \"which of my deals are in LA\". They AND together\n and must all match the same associated entity. Spell the state out\n ('Florida'), or pass a two-letter code with `country` ('FL' + 'US'); a\n code alone returns 400, since unscoped 'FL' resolves to Flintshire, GB\n- value_from / value_to, probability_from / probability_to: inclusive range filters\n- updated_after / updated_before: ISO 8601 date/datetime range on updated_at\n- source_date_from / source_date_to: ISO 8601 dates, required together\n- close_date_from / close_date_to: ISO 8601 dates, required together; opportunities\n with no close_date are excluded\n- last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required\n together\n- next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required\n together; an associated person or company has its next meeting in range\n- include_no_next_meeting: true for only opportunities with no meeting\n scheduled with any associated person or company; overrides\n next_meeting_at_from / next_meeting_at_to\n- days_in_stage_from / days_in_stage_to: inclusive range on days since the\n most recent stage change; either end may be omitted\n\nSort parameters:\n- sort_by: name | created_at | updated_at | value | weighted_value | probability |\n source_date | intro_date | close_date | last_activity_date | details | next_step |\n stage | owner | intro_person | days_in_stage | notes_and_files_count\n- order: asc | desc (default: asc)\n\nPagination:\n- page: Page number (default: 1)\n- per_page: Results per page (default: 10)\n\nThe response also includes `total_value`/`total_weighted_value`: sums of\n`value`/`weighted_value` across the full filtered set, not just the page.","href":"/api-reference/opportunity/list-opportunities"},"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 li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a paginated list of opportunities visible to the tenant ring.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Filter parameters (all optional):\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"name: Case-insensitive substring match on the opportunity’s own name\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"search: Search name and associated person/company names. All words must\\nmatch, in any order; falls back to fuzzy matching when nothing does.\\nDoes not search the opportunity type label\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type\\nname, including a sub-label, with GET /v1/opportunity-types\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"opportunity_stage_uuid: Filter by a single stage UUID\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage\\nnames aren’t accepted; the parameter description explains how to\\nresolve one, including names shared by several stages\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"owner_user_uuid: Comma-separated owner UUID(s); accepts either a user\\nUUID or the person UUID shown as \", _jsx(_components.code, {\n children: \"owner.uuid\"\n }), \" on a record. Returns 400\\nif none of them resolve to a user in this tenant\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"include_no_owner: Widens owner_user_uuid to also match opportunities with\\nno owner; no effect unless owner_user_uuid is set\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"has_owner: true for only owned opportunities, false for only unassigned\\nones; omit for both\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"intro_person_uuid: Filter by the intro person’s UUID\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"related_company_uuid / related_person_uuid: parent opportunities that have a\\nsub-opportunity associated with this entity\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"parent_uuid: Return only sub-opportunities of this parent UUID\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"hierarchy_type: ‘PARENT’ or ‘CHILD’ (ignored if parent_uuid is set)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities\\nassociated with any of them\"\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"city / state / country: Where an associated person or company is based —\\nthis is how you answer “which of my deals are in LA”. They AND together\\nand must all match the same associated entity. Spell the state out\\n(‘Florida’), or pass a two-letter code with \", _jsx(_components.code, {\n children: \"country\"\n }), \" (‘FL’ + ‘US’); a\\ncode alone returns 400, since unscoped ‘FL’ resolves to Flintshire, GB\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"value_from / value_to, probability_from / probability_to: inclusive range filters\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"updated_after / updated_before: ISO 8601 date/datetime range on updated_at\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"source_date_from / source_date_to: ISO 8601 dates, required together\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"close_date_from / close_date_to: ISO 8601 dates, required together; opportunities\\nwith no close_date are excluded\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required\\ntogether\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required\\ntogether; an associated person or company has its next meeting in range\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"include_no_next_meeting: true for only opportunities with no meeting\\nscheduled with any associated person or company; overrides\\nnext_meeting_at_from / next_meeting_at_to\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"days_in_stage_from / days_in_stage_to: inclusive range on days since the\\nmost recent stage change; either end may be omitted\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Sort parameters:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"sort_by: name | created_at | updated_at | value | weighted_value | probability |\\nsource_date | intro_date | close_date | last_activity_date | details | next_step |\\nstage | owner | intro_person | days_in_stage | notes_and_files_count\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"order: asc | desc (default: asc)\"\n }), \"\\n\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Pagination:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"page: Page number (default: 1)\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"per_page: Results per page (default: 10)\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"The response also includes \", _jsx(_components.code, {\n children: \"total_value\"\n }), \"/\", _jsx(_components.code, {\n children: \"total_weighted_value\"\n }), \": sums of\\n\", _jsx(_components.code, {\n children: \"value\"\n }), \"/\", _jsx(_components.code, {\n children: \"weighted_value\"\n }), \" across the full filtered set, not just the page.\"]\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":"List opportunities","openapi":"GET /v1/opportunities","description":"\nReturns a paginated list of opportunities visible to the tenant ring.\n\nFilter parameters (all optional):\n- name: Case-insensitive substring match on the opportunity's own name\n- search: Search name and associated person/company names. All words must\n match, in any order; falls back to fuzzy matching when nothing does.\n Does not search the opportunity type label\n- opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type\n name, including a sub-label, with GET /v1/opportunity-types\n- opportunity_stage_uuid: Filter by a single stage UUID\n- opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage\n names aren't accepted; the parameter description explains how to\n resolve one, including names shared by several stages\n- owner_user_uuid: Comma-separated owner UUID(s); accepts either a user\n UUID or the person UUID shown as `owner.uuid` on a record. Returns 400\n if none of them resolve to a user in this tenant\n- include_no_owner: Widens owner_user_uuid to also match opportunities with\n no owner; no effect unless owner_user_uuid is set\n- has_owner: true for only owned opportunities, false for only unassigned\n ones; omit for both\n- intro_person_uuid: Filter by the intro person's UUID\n- related_company_uuid / related_person_uuid: parent opportunities that have a\n sub-opportunity associated with this entity\n- parent_uuid: Return only sub-opportunities of this parent UUID\n- hierarchy_type: 'PARENT' or 'CHILD' (ignored if parent_uuid is set)\n- company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities\n associated with any of them\n- city / state / country: Where an associated person or company is based —\n this is how you answer \"which of my deals are in LA\". They AND together\n and must all match the same associated entity. Spell the state out\n ('Florida'), or pass a two-letter code with `country` ('FL' + 'US'); a\n code alone returns 400, since unscoped 'FL' resolves to Flintshire, GB\n- value_from / value_to, probability_from / probability_to: inclusive range filters\n- updated_after / updated_before: ISO 8601 date/datetime range on updated_at\n- source_date_from / source_date_to: ISO 8601 dates, required together\n- close_date_from / close_date_to: ISO 8601 dates, required together; opportunities\n with no close_date are excluded\n- last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required\n together\n- next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required\n together; an associated person or company has its next meeting in range\n- include_no_next_meeting: true for only opportunities with no meeting\n scheduled with any associated person or company; overrides\n next_meeting_at_from / next_meeting_at_to\n- days_in_stage_from / days_in_stage_to: inclusive range on days since the\n most recent stage change; either end may be omitted\n\nSort parameters:\n- sort_by: name | created_at | updated_at | value | weighted_value | probability |\n source_date | intro_date | close_date | last_activity_date | details | next_step |\n stage | owner | intro_person | days_in_stage | notes_and_files_count\n- order: asc | desc (default: asc)\n\nPagination:\n- page: Page number (default: 1)\n- per_page: Results per page (default: 10)\n\nThe response also includes `total_value`/`total_weighted_value`: sums of\n`value`/`weighted_value` across the full filtered set, not just the page.","href":"/api-reference/opportunity/list-opportunities"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"\nReturns a paginated list of opportunities visible to the tenant ring.\n\nFilter parameters (all optional):\n- name: Case-insensitive substring match on the opportunity's own name\n- search: Search name and associated person/company names. All words must\n match, in any order; falls back to fuzzy matching when nothing does.\n Does not search the opportunity type label\n- opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type\n name, including a sub-label, with GET /v1/opportunity-types\n- opportunity_stage_uuid: Filter by a single stage UUID\n- opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage\n names aren't accepted; the parameter description explains how to\n resolve one, including names shared by several stages\n- owner_user_uuid: Comma-separated owner UUID(s); accepts either a user\n UUID or the person UUID shown as `owner.uuid` on a record. Returns 400\n if none of them resolve to a user in this tenant\n- include_no_owner: Widens owner_user_uuid to also match opportunities with\n no owner; no effect unless owner_user_uuid is set\n- has_owner: true for only owned opportunities, false for only unassigned\n ones; omit for both\n- intro_person_uuid: Filter by the intro person's UUID\n- related_company_uuid / related_person_uuid: parent opportunities that have a\n sub-opportunity associated with this entity\n- parent_uuid: Return only sub-opportunities of this parent UUID\n- hierarchy_type: 'PARENT' or 'CHILD' (ignored if parent_uuid is set)\n- company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities\n associated with any of them\n- city / state / country: Where an associated person or company is based —\n this is how you answer \"which of my deals are in LA\". They AND together\n and must all match the same associated entity. Spell the state out\n ('Florida'), or pass a two-letter code with `country` ('FL' + 'US'); a\n code alone returns 400, since unscoped 'FL' resolves to Flintshire, GB\n- value_from / value_to, probability_from / probability_to: inclusive range filters\n- updated_after / updated_before: ISO 8601 date/datetime range on updated_at\n- source_date_from / source_date_to: ISO 8601 dates, required together\n- close_date_from / close_date_to: ISO 8601 dates, required together; opportunities\n with no close_date are excluded\n- last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required\n together\n- next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required\n together; an associated person or company has its next meeting in range\n- include_no_next_meeting: true for only opportunities with no meeting\n scheduled with any associated person or company; overrides\n next_meeting_at_from / next_meeting_at_to\n- days_in_stage_from / days_in_stage_to: inclusive range on days since the\n most recent stage change; either end may be omitted\n\nSort parameters:\n- sort_by: name | created_at | updated_at | value | weighted_value | probability |\n source_date | intro_date | close_date | last_activity_date | details | next_step |\n stage | owner | intro_person | days_in_stage | notes_and_files_count\n- order: asc | desc (default: asc)\n\nPagination:\n- page: Page number (default: 1)\n- per_page: Results per page (default: 10)\n\nThe response also includes `total_value`/`total_weighted_value`: sums of\n`value`/`weighted_value` across the full filtered set, not just the page.","operationId":"get_list_opportunities","parameters":["8642abdb-8942-4251-8639-850051da782e","278543e5-6d3b-4f4c-8f87-bebc1653cc8d","4a43ea10-cef8-4e60-95b5-24d8cbf4eb27","50290ec8-cf29-48ee-93b8-fe19c0ddb920","28bd0612-d760-466c-82cc-0a28a7e0ffe8","2ff0570f-96e4-42fc-9151-321e93cf61c2","84717dcd-9d9b-4e29-8f50-3a6c697a5148","d869e893-5bd6-423c-8917-464820b35dc2","9f5ef2e5-65ec-416f-a7ff-b048e9ca5334","b2608acf-6c09-43ba-87c5-fec61e8d3a07","10cd3c0d-e881-43be-a67e-07092740375c","a029c7f5-f0f0-4098-8b5b-e36de54cac3d","acfe9c7d-0834-45ef-b6bb-afc15d312fa4","76921667-c89c-4fad-b3e0-1e7411ab438b","59b01284-a332-4048-991f-4e5041e24e39","cfdd68b0-11c2-49fe-9f6f-5bf81e8da277","7e33ea4a-6551-4820-8367-496e37e09014","d949fa3d-2bc2-4300-9a89-a78f32a66997","eff1347b-7834-4566-9b75-be10622bf3e1","62ef696e-5adc-4007-be3d-614a1ebb8470","2e63955d-43eb-46c9-811c-dcc20121fd49","698bfe0b-851b-4779-847a-983313b7fc00","9df5f45c-6973-462f-a2ed-a012b6222db9","8954a724-9f22-411f-a18d-0e4fd76f0399","2e9b6972-5277-438e-b9ce-0a0447447136","71baaba8-4444-41a5-ab3a-8eb0ea4788a4","20a210fb-6c6f-4474-b317-4c832bf6d49f","bafa4887-3755-477c-a370-14eb57cff853","29fdde29-beda-4635-ba99-074f0d50b49d","2aafe36b-5b82-4655-a14c-b75eca16c5ea","e9a58c84-60a8-42f4-a185-76e1c90564fd","a1a106b0-ae9c-4579-a57e-6c8a8fd4beba","43b5d79b-031b-447a-9aad-54228eed9484","4dd72060-5f58-457e-8d1d-b8e09be80da9","41c45d98-a52b-4a91-ae26-a7e00e3dc684","0a31f725-0b31-47e3-a379-18f3655e1702","cf06649e-7851-4085-af02-b6468ef4cc27","d27b12a0-8ae8-441a-ae7b-712ef361633a","315efddb-4b62-43d0-b8d0-d9c0ff611df4","f7899ca8-62df-4042-8bcc-ca489bab6db5","850aaa8a-b939-4ad8-952f-f86623954c55"],"responses":{"200":"d4f4720f-5d32-4ad1-9685-989d2d5c29e2"},"summary":"List opportunities in the caller's tenant with optional filtering and pagination.","tags":["Opportunity"],"method":"get","type":"path","servers":["ac0c72ea-24cd-42c5-bf7e-af9869eeb624"],"security":["d3e1b4d8-8e73-42d2-8242-48f05e417bca"],"path":"/v1/opportunities","baseUrlOptions":["https://production-api.joinrings.com"],"title":"List opportunities in the caller's tenant with optional filtering and pagination.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8642abdb-8942-4251-8639-850051da782e":{"description":"Page number, 1-indexed. Clamped to >= 1.","in":"query","name":"page","required":false,"schema":{"default":1,"title":"Page","type":"integer","isRequired":false,"description":"Page number, 1-indexed. Clamped to >= 1.","uniqueKey":"","typeLabel":"integer"}},"278543e5-6d3b-4f4c-8f87-bebc1653cc8d":{"description":"Results per page (default 10). Clamped to the range 1-50 (values outside are silently capped, not rejected).","in":"query","name":"per_page","required":false,"schema":{"default":10,"title":"Per Page","type":"integer","isRequired":false,"description":"Results per page (default 10). Clamped to the range 1-50 (values outside are silently capped, not rejected).","uniqueKey":"","typeLabel":"integer"}},"4a43ea10-cef8-4e60-95b5-24d8cbf4eb27":{"description":"Opaque cursor from a previous response's `next_cursor`. When supplied, the page starts immediately after the last record of that response and `page` is ignored — unlike `page`, this cannot skip or repeat records when the data changes mid-scan. Filters and sort must stay identical for the whole scan; changing one is a 400. Not supported by every list endpoint — those that support it return `next_cursor`.","in":"query","name":"after","required":false,"schema":{"oneOf":[{"type":"string","title":"After","description":"Opaque cursor from a previous response's `next_cursor`. When supplied, the page starts immediately after the last record of that response and `page` is ignored — unlike `page`, this cannot skip or repeat records when the data changes mid-scan. Filters and sort must stay identical for the whole scan; changing one is a 400. Not supported by every list endpoint — those that support it return `next_cursor`.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"After","description":"Opaque cursor from a previous response's `next_cursor`. When supplied, the page starts immediately after the last record of that response and `page` is ignored — unlike `page`, this cannot skip or repeat records when the data changes mid-scan. Filters and sort must stay identical for the whole scan; changing one is a 400. Not supported by every list endpoint — those that support it return `next_cursor`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"50290ec8-cf29-48ee-93b8-fe19c0ddb920":{"description":"Case-insensitive substring match on opportunity name.","in":"query","name":"name","required":false,"schema":{"oneOf":[{"type":"string","title":"Name","description":"Case-insensitive substring match on opportunity name.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","description":"Case-insensitive substring match on opportunity name.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"28bd0612-d760-466c-82cc-0a28a7e0ffe8":{"description":"Filter by opportunity type UUID (call GET /v1/opportunity-types to discover valid values).","in":"query","name":"opportunity_type_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Opportunity Type Uuid","description":"Filter by opportunity type UUID (call GET /v1/opportunity-types to discover valid values).","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Opportunity Type Uuid","description":"Filter by opportunity type UUID (call GET /v1/opportunity-types to discover valid values).","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"2ff0570f-96e4-42fc-9151-321e93cf61c2":{"description":"Filter by a single opportunity stage UUID. To filter by a stage name, use `opportunity_stage_uuids` instead: one name can belong to several stages.","in":"query","name":"opportunity_stage_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Opportunity Stage Uuid","description":"Filter by a single opportunity stage UUID. To filter by a stage name, use `opportunity_stage_uuids` instead: one name can belong to several stages.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Opportunity Stage Uuid","description":"Filter by a single opportunity stage UUID. To filter by a stage name, use `opportunity_stage_uuids` instead: one name can belong to several stages.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"84717dcd-9d9b-4e29-8f50-3a6c697a5148":{"description":"Comma-separated list of opportunity stage UUIDs (IN filter, e.g. for 'Diligence or later'). Stage names aren't accepted. Resolve one with GET /v1/opportunity-types/{type_uuid}/stages, or GET /v1/opportunities/grouped?group_by=STAGE when the type is unknown (`group_label` is the name, `group_key` the UUID). This lookup omits stages with no opportunities. A name can belong to several stages, so pass every matching UUID.","in":"query","name":"opportunity_stage_uuids","required":false,"schema":{"oneOf":[{"type":"string","title":"Opportunity Stage Uuids","description":"Comma-separated list of opportunity stage UUIDs (IN filter, e.g. for 'Diligence or later'). Stage names aren't accepted. Resolve one with GET /v1/opportunity-types/{type_uuid}/stages, or GET /v1/opportunities/grouped?group_by=STAGE when the type is unknown (`group_label` is the name, `group_key` the UUID). This lookup omits stages with no opportunities. A name can belong to several stages, so pass every matching UUID.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Opportunity Stage Uuids","description":"Comma-separated list of opportunity stage UUIDs (IN filter, e.g. for 'Diligence or later'). Stage names aren't accepted. Resolve one with GET /v1/opportunity-types/{type_uuid}/stages, or GET /v1/opportunities/grouped?group_by=STAGE when the type is unknown (`group_label` is the name, `group_key` the UUID). This lookup omits stages with no opportunities. A name can belong to several stages, so pass every matching UUID.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"d869e893-5bd6-423c-8917-464820b35dc2":{"description":"Search the opportunity name and its associated person/company names. Every whitespace-separated word must appear, in any order. If nothing matches, retries fuzzily so near-misses and typos still return results rather than an empty page, closest match first unless `sort_by` is given. Broader than `name`, which only matches the opportunity's own name field. Does not search the opportunity type label.","in":"query","name":"search","required":false,"schema":{"oneOf":[{"type":"string","title":"Search","description":"Search the opportunity name and its associated person/company names. Every whitespace-separated word must appear, in any order. If nothing matches, retries fuzzily so near-misses and typos still return results rather than an empty page, closest match first unless `sort_by` is given. Broader than `name`, which only matches the opportunity's own name field. Does not search the opportunity type label.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Search","description":"Search the opportunity name and its associated person/company names. Every whitespace-separated word must appear, in any order. If nothing matches, retries fuzzily so near-misses and typos still return results rather than an empty page, closest match first unless `sort_by` is given. Broader than `name`, which only matches the opportunity's own name field. Does not search the opportunity type label.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"9f5ef2e5-65ec-416f-a7ff-b048e9ca5334":{"description":"Comma-separated owner UUID(s); filters by the opportunity owner. Accepts either a user UUID or the person UUID shown as `owner.uuid` on a record. Returns 400 if none resolve.","in":"query","name":"owner_user_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Owner User Uuid","description":"Comma-separated owner UUID(s); filters by the opportunity owner. Accepts either a user UUID or the person UUID shown as `owner.uuid` on a record. Returns 400 if none resolve.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Owner User Uuid","description":"Comma-separated owner UUID(s); filters by the opportunity owner. Accepts either a user UUID or the person UUID shown as `owner.uuid` on a record. Returns 400 if none resolve.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"b2608acf-6c09-43ba-87c5-fec61e8d3a07":{"description":"Widens `owner_user_uuid` to also match opportunities with no owner. Has no effect on its own -- unowned opportunities are already returned when no owner filter is set.","in":"query","name":"include_no_owner","required":false,"schema":{"default":false,"title":"Include No Owner","type":"boolean","isRequired":false,"description":"Widens `owner_user_uuid` to also match opportunities with no owner. Has no effect on its own -- unowned opportunities are already returned when no owner filter is set.","uniqueKey":"","typeLabel":"boolean"}},"10cd3c0d-e881-43be-a67e-07092740375c":{"description":"`true` returns only opportunities that have an owner, `false` only the unassigned ones. Omit to return both.","in":"query","name":"has_owner","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Has Owner","description":"`true` returns only opportunities that have an owner, `false` only the unassigned ones. Omit to return both.","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Has Owner","description":"`true` returns only opportunities that have an owner, `false` only the unassigned ones. Omit to return both.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"a029c7f5-f0f0-4098-8b5b-e36de54cac3d":{"description":"Filter by the intro person's UUID.","in":"query","name":"intro_person_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Intro Person Uuid","description":"Filter by the intro person's UUID.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Intro Person Uuid","description":"Filter by the intro person's UUID.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"acfe9c7d-0834-45ef-b6bb-afc15d312fa4":{"description":"Return parent opportunities that have a sub-opportunity associated with this company UUID.","in":"query","name":"related_company_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Related Company Uuid","description":"Return parent opportunities that have a sub-opportunity associated with this company UUID.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Related Company Uuid","description":"Return parent opportunities that have a sub-opportunity associated with this company UUID.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"76921667-c89c-4fad-b3e0-1e7411ab438b":{"description":"Return parent opportunities that have a sub-opportunity associated with this person UUID.","in":"query","name":"related_person_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Related Person Uuid","description":"Return parent opportunities that have a sub-opportunity associated with this person UUID.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Related Person Uuid","description":"Return parent opportunities that have a sub-opportunity associated with this person UUID.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"59b01284-a332-4048-991f-4e5041e24e39":{"description":"Return only the sub-opportunities of this parent opportunity UUID.","in":"query","name":"parent_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Parent Uuid","description":"Return only the sub-opportunities of this parent opportunity UUID.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Uuid","description":"Return only the sub-opportunities of this parent opportunity UUID.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"cfdd68b0-11c2-49fe-9f6f-5bf81e8da277":{"description":"'PARENT' for top-level opportunities only, 'CHILD' for sub-opportunities only. Ignored when `parent_uuid` is set.","in":"query","name":"hierarchy_type","required":false,"schema":{"oneOf":[{"type":"string","title":"Hierarchy Type","enum":["PARENT","CHILD"],"description":"'PARENT' for top-level opportunities only, 'CHILD' for sub-opportunities only. Ignored when `parent_uuid` is set.","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Hierarchy Type","description":"'PARENT' for top-level opportunities only, 'CHILD' for sub-opportunities only. Ignored when `parent_uuid` is set.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"7e33ea4a-6551-4820-8367-496e37e09014":{"description":"Comma-separated company UUID(s); returns opportunities associated with any of them.","in":"query","name":"company_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Company Uuid","description":"Comma-separated company UUID(s); returns opportunities associated with any of them.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Uuid","description":"Comma-separated company UUID(s); returns opportunities associated with any of them.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"d949fa3d-2bc2-4300-9a89-a78f32a66997":{"description":"Case-insensitive substring on the city of an associated person or company (e.g. 'Los Angeles'). Pass the full city name, not an abbreviation — 'LA' is matched as a substring and hits Dallas and Cleveland, not Los Angeles. Prefer this over paging the list and filtering client-side.","in":"query","name":"city","required":false,"schema":{"oneOf":[{"type":"string","title":"City","description":"Case-insensitive substring on the city of an associated person or company (e.g. 'Los Angeles'). Pass the full city name, not an abbreviation — 'LA' is matched as a substring and hits Dallas and Cleveland, not Los Angeles. Prefer this over paging the list and filtering client-side.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"City","description":"Case-insensitive substring on the city of an associated person or company (e.g. 'Los Angeles'). Pass the full city name, not an abbreviation — 'LA' is matched as a substring and hits Dallas and Cleveland, not Los Angeles. Prefer this over paging the list and filtering client-side.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"eff1347b-7834-4566-9b75-be10622bf3e1":{"description":"State/region of an associated person or company. A full name ('Florida') works on its own; a two-letter code ('FL', 'NY') is ISO 3166-2 and requires `country`, since unscoped 'FL' means Flintshire, GB. Returns 400 if it does not resolve.","in":"query","name":"state","required":false,"schema":{"oneOf":[{"type":"string","title":"State","description":"State/region of an associated person or company. A full name ('Florida') works on its own; a two-letter code ('FL', 'NY') is ISO 3166-2 and requires `country`, since unscoped 'FL' means Flintshire, GB. Returns 400 if it does not resolve.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"State","description":"State/region of an associated person or company. A full name ('Florida') works on its own; a two-letter code ('FL', 'NY') is ISO 3166-2 and requires `country`, since unscoped 'FL' means Flintshire, GB. Returns 400 if it does not resolve.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"62ef696e-5adc-4007-be3d-614a1ebb8470":{"description":"Country of an associated person or company, name or ISO code ('US', 'United States'). Returns 400 if unrecognized.","in":"query","name":"country","required":false,"schema":{"oneOf":[{"type":"string","title":"Country","description":"Country of an associated person or company, name or ISO code ('US', 'United States'). Returns 400 if unrecognized.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","description":"Country of an associated person or company, name or ISO code ('US', 'United States'). Returns 400 if unrecognized.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"2e63955d-43eb-46c9-811c-dcc20121fd49":{"description":"Comma-separated person UUID(s); returns opportunities associated with any of them.","in":"query","name":"person_uuid","required":false,"schema":{"oneOf":[{"type":"string","title":"Person Uuid","description":"Comma-separated person UUID(s); returns opportunities associated with any of them.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Person Uuid","description":"Comma-separated person UUID(s); returns opportunities associated with any of them.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"698bfe0b-851b-4779-847a-983313b7fc00":{"description":"Minimum `value`, inclusive.","in":"query","name":"value_from","required":false,"schema":{"oneOf":[{"type":"integer","title":"Value From","description":"Minimum `value`, inclusive.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value From","description":"Minimum `value`, inclusive.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"9df5f45c-6973-462f-a2ed-a012b6222db9":{"description":"Maximum `value`, inclusive.","in":"query","name":"value_to","required":false,"schema":{"oneOf":[{"type":"integer","title":"Value To","description":"Maximum `value`, inclusive.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value To","description":"Maximum `value`, inclusive.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"8954a724-9f22-411f-a18d-0e4fd76f0399":{"description":"Minimum `probability`, inclusive.","in":"query","name":"probability_from","required":false,"schema":{"oneOf":[{"type":"integer","title":"Probability From","description":"Minimum `probability`, inclusive.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Probability From","description":"Minimum `probability`, inclusive.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"2e9b6972-5277-438e-b9ce-0a0447447136":{"description":"Maximum `probability`, inclusive.","in":"query","name":"probability_to","required":false,"schema":{"oneOf":[{"type":"integer","title":"Probability To","description":"Maximum `probability`, inclusive.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Probability To","description":"Maximum `probability`, inclusive.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"71baaba8-4444-41a5-ab3a-8eb0ea4788a4":{"description":"ISO 8601 date/datetime; only return opportunities updated at or after this time.","in":"query","name":"updated_after","required":false,"schema":{"oneOf":[{"type":"string","title":"Updated After","description":"ISO 8601 date/datetime; only return opportunities updated at or after this time.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Updated After","description":"ISO 8601 date/datetime; only return opportunities updated at or after this time.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"20a210fb-6c6f-4474-b317-4c832bf6d49f":{"description":"ISO 8601 date/datetime; only return opportunities updated at or before this time.","in":"query","name":"updated_before","required":false,"schema":{"oneOf":[{"type":"string","title":"Updated Before","description":"ISO 8601 date/datetime; only return opportunities updated at or before this time.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Updated Before","description":"ISO 8601 date/datetime; only return opportunities updated at or before this time.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"bafa4887-3755-477c-a370-14eb57cff853":{"description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `source_date_to` — both are required together.","in":"query","name":"source_date_from","required":false,"schema":{"oneOf":[{"type":"string","title":"Source Date From","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `source_date_to` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Source Date From","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `source_date_to` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"29fdde29-beda-4635-ba99-074f0d50b49d":{"description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `source_date_from` — both are required together.","in":"query","name":"source_date_to","required":false,"schema":{"oneOf":[{"type":"string","title":"Source Date To","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `source_date_from` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Source Date To","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `source_date_from` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"2aafe36b-5b82-4655-a14c-b75eca16c5ea":{"description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `close_date_to` — both are required together.","in":"query","name":"close_date_from","required":false,"schema":{"oneOf":[{"type":"string","title":"Close Date From","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `close_date_to` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Close Date From","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `close_date_to` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"e9a58c84-60a8-42f4-a185-76e1c90564fd":{"description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `close_date_from` — both are required together.","in":"query","name":"close_date_to","required":false,"schema":{"oneOf":[{"type":"string","title":"Close Date To","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `close_date_from` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Close Date To","description":"ISO 8601 date (YYYY-MM-DD). Must be paired with `close_date_from` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"a1a106b0-ae9c-4579-a57e-6c8a8fd4beba":{"description":"ISO 8601 datetime. Must be paired with `last_activity_date_to` — both are required together.","in":"query","name":"last_activity_date_from","required":false,"schema":{"oneOf":[{"type":"string","title":"Last Activity Date From","description":"ISO 8601 datetime. Must be paired with `last_activity_date_to` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date From","description":"ISO 8601 datetime. Must be paired with `last_activity_date_to` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"43b5d79b-031b-447a-9aad-54228eed9484":{"description":"ISO 8601 datetime. Must be paired with `last_activity_date_from` — both are required together.","in":"query","name":"last_activity_date_to","required":false,"schema":{"oneOf":[{"type":"string","title":"Last Activity Date To","description":"ISO 8601 datetime. Must be paired with `last_activity_date_from` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date To","description":"ISO 8601 datetime. Must be paired with `last_activity_date_from` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"4dd72060-5f58-457e-8d1d-b8e09be80da9":{"description":"ISO 8601 datetime. Must be paired with `next_meeting_at_to` — both are required together. Matches opportunities where an associated person or company has its next meeting in this window. Ignored when `include_no_next_meeting=true`.","in":"query","name":"next_meeting_at_from","required":false,"schema":{"oneOf":[{"type":"string","title":"Next Meeting At From","description":"ISO 8601 datetime. Must be paired with `next_meeting_at_to` — both are required together. Matches opportunities where an associated person or company has its next meeting in this window. Ignored when `include_no_next_meeting=true`.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Meeting At From","description":"ISO 8601 datetime. Must be paired with `next_meeting_at_to` — both are required together. Matches opportunities where an associated person or company has its next meeting in this window. Ignored when `include_no_next_meeting=true`.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"41c45d98-a52b-4a91-ae26-a7e00e3dc684":{"description":"ISO 8601 datetime. Must be paired with `next_meeting_at_from` — both are required together.","in":"query","name":"next_meeting_at_to","required":false,"schema":{"oneOf":[{"type":"string","title":"Next Meeting At To","description":"ISO 8601 datetime. Must be paired with `next_meeting_at_from` — both are required together.","uniqueKey":"oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Meeting At To","description":"ISO 8601 datetime. Must be paired with `next_meeting_at_from` — both are required together.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string | null"}},"0a31f725-0b31-47e3-a379-18f3655e1702":{"description":"`true` returns only opportunities with no meeting scheduled — none of their associated people or companies has an upcoming meeting. Omit (or `false`) to apply no meeting filter.","in":"query","name":"include_no_next_meeting","required":false,"schema":{"oneOf":[{"type":"boolean","title":"Include No Next Meeting","description":"`true` returns only opportunities with no meeting scheduled — none of their associated people or companies has an upcoming meeting. Omit (or `false`) to apply no meeting filter.","uniqueKey":"oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Include No Next Meeting","description":"`true` returns only opportunities with no meeting scheduled — none of their associated people or companies has an upcoming meeting. Omit (or `false`) to apply no meeting filter.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"boolean | null"}},"cf06649e-7851-4085-af02-b6468ef4cc27":{"description":"Minimum days since the opportunity's most recent stage change, inclusive — e.g. 30 for deals stuck a month or more. Opportunities with no recorded stage change are excluded.","in":"query","name":"days_in_stage_from","required":false,"schema":{"oneOf":[{"type":"integer","title":"Days In Stage From","description":"Minimum days since the opportunity's most recent stage change, inclusive — e.g. 30 for deals stuck a month or more. Opportunities with no recorded stage change are excluded.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Days In Stage From","description":"Minimum days since the opportunity's most recent stage change, inclusive — e.g. 30 for deals stuck a month or more. Opportunities with no recorded stage change are excluded.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"d27b12a0-8ae8-441a-ae7b-712ef361633a":{"description":"Maximum days since the opportunity's most recent stage change, inclusive. Opportunities with no recorded stage change are excluded.","in":"query","name":"days_in_stage_to","required":false,"schema":{"oneOf":[{"type":"integer","title":"Days In Stage To","description":"Maximum days since the opportunity's most recent stage change, inclusive. Opportunities with no recorded stage change are excluded.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","title":"Days In Stage To","description":"Maximum days since the opportunity's most recent stage change, inclusive. Opportunities with no recorded stage change are excluded.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"}},"315efddb-4b62-43d0-b8d0-d9c0ff611df4":{"description":"Sort order. Valid values: 'asc' (ascending) or 'desc' (descending)","in":"query","name":"order","required":false,"schema":{"default":"asc","enum":["asc","desc"],"title":"Order","type":"string","isRequired":false,"description":"Sort order. Valid values: 'asc' (ascending) or 'desc' (descending)","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"f7899ca8-62df-4042-8bcc-ca489bab6db5":{"description":"Field to sort by. Valid values: 'name', 'created_at', 'updated_at', 'value', 'weighted_value', 'probability', 'source_date', 'intro_date', 'close_date', 'last_activity_date', 'details', 'next_step', 'stage' (pipeline stage order), 'owner' (by name), 'intro_person' (by name), 'days_in_stage', 'notes_and_files_count'","in":"query","name":"sort_by","required":false,"schema":{"oneOf":[{"type":"string","title":"Sort By","enum":["name","created_at","updated_at","value","weighted_value","probability","source_date","intro_date","close_date","last_activity_date","details","next_step","stage","owner","intro_person","days_in_stage","notes_and_files_count"],"description":"Field to sort by. Valid values: 'name', 'created_at', 'updated_at', 'value', 'weighted_value', 'probability', 'source_date', 'intro_date', 'close_date', 'last_activity_date', 'details', 'next_step', 'stage' (pipeline stage order), 'owner' (by name), 'intro_person' (by name), 'days_in_stage', 'notes_and_files_count'","uniqueKey":"oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Sort By","description":"Field to sort by. Valid values: 'name', 'created_at', 'updated_at', 'value', 'weighted_value', 'probability', 'source_date', 'intro_date', 'close_date', 'last_activity_date', 'details', 'next_step', 'stage' (pipeline stage order), 'owner' (by name), 'intro_person' (by name), 'days_in_stage', 'notes_and_files_count'","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring> | null"}},"850aaa8a-b939-4ad8-952f-f86623954c55":{"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":{"d4f4720f-5d32-4ad1-9685-989d2d5c29e2":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].uuid","typeLabel":"string"},"associations":{"oneOf":[{"type":"array","items":{"properties":{"association_type":{"oneOf":[{"type":"string","title":"Association Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].association_type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Association Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].association_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].association_type","typeLabel":"string | null"},"context":{"oneOf":[{"type":"string","title":"Context","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].context.oneOf.0","typeLabel":"string"},{"type":"null","title":"Context","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].context.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].context","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].entity_type","typeLabel":"enum\u003cstring>"},"entity_uuid":{"title":"Entity Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].entity_uuid","typeLabel":"string"},"last_activity_date":{"oneOf":[{"type":"string","title":"Last Activity Date","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].last_activity_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].last_activity_date","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"number","title":"Updated At","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].updated_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Updated At","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].updated_at","typeLabel":"number | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.kind.oneOf.0","typeLabel":"string"},{"type":"null","title":"Kind","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.kind.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.kind","typeLabel":"string | null"},"object_id":{"title":"Object Id","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.object_id","typeLabel":"string"},"title":{"oneOf":[{"type":"string","title":"Title","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.title.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.title","typeLabel":"string | null"},"end_date":{"oneOf":[{"type":"string","title":"End Date","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.end_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"End Date","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.end_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.end_date","typeLabel":"string | null"},"start_date":{"oneOf":[{"type":"string","title":"Start Date","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.start_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Start Date","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.start_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0.start_date","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.0","typeLabel":"AssociatedActivity · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].activity.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.last_activity_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.type","typeLabel":"string | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.uuid","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.country","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.0","typeLabel":"AssociatedCompany · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].company.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.is_sub_opportunity","typeLabel":"boolean"},"name":{"oneOf":[{"type":"string","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.name","typeLabel":"string | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.uuid","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.0","typeLabel":"OpportunityStageOnRecord · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.label","typeLabel":"string"},"label_plural":{"title":"Label Plural","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.sub_label_plural","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.uuid","typeLabel":"string"},"is_hidden":{"oneOf":[{"type":"boolean","title":"Is Hidden","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.is_hidden.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Hidden","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.is_hidden.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0.is_hidden","typeLabel":"boolean | null"}},"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.0","typeLabel":"OpportunityTypeOnRecord · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0.type","typeLabel":"OpportunityTypeOnRecord · object | null"}},"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.0","typeLabel":"AssociatedOpportunity · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].opportunity.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","title":"Email","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.last_activity_date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.type","typeLabel":"string | null"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.uuid","typeLabel":"string"},"city":{"oneOf":[{"type":"string","title":"City","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","title":"City","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.city","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","title":"Country","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","title":"Country","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.country","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","title":"State","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","title":"State","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0.state","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.0","typeLabel":"AssociatedPerson · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX].person.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].associations.oneOf.0.items.[INDEX]","typeLabel":"OpportunityAssociation · object"},"title":"Associations","uniqueKey":"\\items.items.[INDEX].associations.oneOf.0","typeLabel":"OpportunityAssociation · object[]"},{"type":"null","title":"Associations","uniqueKey":"\\items.items.[INDEX].associations.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].children_metadata.oneOf.0.count","typeLabel":"integer"},"probability_sum":{"title":"Probability Sum","type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].children_metadata.oneOf.0.probability_sum","typeLabel":"integer"},"value_sum":{"title":"Value Sum","type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].children_metadata.oneOf.0.value_sum","typeLabel":"integer"},"weighted_value_sum":{"title":"Weighted Value Sum","type":"integer","isRequired":true,"uniqueKey":"\\items.items.[INDEX].children_metadata.oneOf.0.weighted_value_sum","typeLabel":"integer"}},"uniqueKey":"\\items.items.[INDEX].children_metadata.oneOf.0","typeLabel":"OpportunityMetadata · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].children_metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].children_metadata","typeLabel":"OpportunityMetadata · object | null"},"close_date":{"oneOf":[{"type":"string","title":"Close Date","uniqueKey":"\\items.items.[INDEX].close_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Close Date","uniqueKey":"\\items.items.[INDEX].close_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].close_date","typeLabel":"string | null"},"company_last_activity_date":{"oneOf":[{"type":"string","title":"Company Last Activity Date","uniqueKey":"\\items.items.[INDEX].company_last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Company Last Activity Date","uniqueKey":"\\items.items.[INDEX].company_last_activity_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].company_last_activity_date","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"number","title":"Created At","uniqueKey":"\\items.items.[INDEX].created_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Created At","uniqueKey":"\\items.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].created_at","typeLabel":"number | null"},"created_by":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].created_by.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].created_by","typeLabel":"RelatedPerson · object | null"},"custom_fields":{"items":{"properties":{"key":{"title":"Key","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].key","typeLabel":"string"},"name":{"title":"Name","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].name","typeLabel":"string"},"type":{"title":"Type","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].type","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].uuid","typeLabel":"string"},"float_value":{"oneOf":[{"type":"number","title":"Float Value","uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].float_value.oneOf.0","typeLabel":"number"},{"type":"null","title":"Float Value","uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].float_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].float_value","typeLabel":"number | null"},"string_value":{"oneOf":[{"type":"string","title":"String Value","uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].string_value.oneOf.0","typeLabel":"string"},{"type":"null","title":"String Value","uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].string_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX].string_value","typeLabel":"string | null"}},"required":["uuid","key","name","type"],"title":"OpportunityCustomFieldValue","type":"object","uniqueKey":"\\items.items.[INDEX].custom_fields.items.[INDEX]","typeLabel":"OpportunityCustomFieldValue · object"},"title":"Custom Fields","type":"array","uniqueKey":"\\items.items.[INDEX].custom_fields","typeLabel":"OpportunityCustomFieldValue · object[]"},"days_in_stage":{"oneOf":[{"type":"integer","title":"Days In Stage","uniqueKey":"\\items.items.[INDEX].days_in_stage.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Days In Stage","uniqueKey":"\\items.items.[INDEX].days_in_stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].days_in_stage","typeLabel":"integer | null"},"details":{"oneOf":[{"type":"string","title":"Details","uniqueKey":"\\items.items.[INDEX].details.oneOf.0","typeLabel":"string"},{"type":"null","title":"Details","uniqueKey":"\\items.items.[INDEX].details.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].details","typeLabel":"string | null"},"intro_date":{"oneOf":[{"type":"string","title":"Intro Date","uniqueKey":"\\items.items.[INDEX].intro_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Intro Date","uniqueKey":"\\items.items.[INDEX].intro_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].intro_date","typeLabel":"string | null"},"intro_person":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].intro_person.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].intro_person","typeLabel":"RelatedPerson · object | null"},"last_activity_date":{"oneOf":[{"type":"string","title":"Last Activity Date","uniqueKey":"\\items.items.[INDEX].last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Last Activity Date","uniqueKey":"\\items.items.[INDEX].last_activity_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].last_activity_date","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string | null"},"next_meeting_at":{"oneOf":[{"type":"string","title":"Next Meeting At","uniqueKey":"\\items.items.[INDEX].next_meeting_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Meeting At","uniqueKey":"\\items.items.[INDEX].next_meeting_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].next_meeting_at","typeLabel":"string | null"},"next_step":{"oneOf":[{"type":"string","title":"Next Step","uniqueKey":"\\items.items.[INDEX].next_step.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Step","uniqueKey":"\\items.items.[INDEX].next_step.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].next_step","typeLabel":"string | null"},"notes_and_files_count":{"oneOf":[{"type":"integer","title":"Notes And Files Count","uniqueKey":"\\items.items.[INDEX].notes_and_files_count.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Notes And Files Count","uniqueKey":"\\items.items.[INDEX].notes_and_files_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].notes_and_files_count","typeLabel":"integer | null"},"owner":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].owner.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].owner.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].owner.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].owner","typeLabel":"RelatedPerson · object | null"},"parent_name":{"oneOf":[{"type":"string","title":"Parent Name","uniqueKey":"\\items.items.[INDEX].parent_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Name","uniqueKey":"\\items.items.[INDEX].parent_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].parent_name","typeLabel":"string | null"},"parent_uuid":{"oneOf":[{"type":"string","title":"Parent Uuid","uniqueKey":"\\items.items.[INDEX].parent_uuid.oneOf.0","typeLabel":"string"},{"type":"null","title":"Parent Uuid","uniqueKey":"\\items.items.[INDEX].parent_uuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].parent_uuid","typeLabel":"string | null"},"person_last_activity_date":{"oneOf":[{"type":"string","title":"Person Last Activity Date","uniqueKey":"\\items.items.[INDEX].person_last_activity_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Person Last Activity Date","uniqueKey":"\\items.items.[INDEX].person_last_activity_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].person_last_activity_date","typeLabel":"string | null"},"probability":{"oneOf":[{"type":"integer","title":"Probability","uniqueKey":"\\items.items.[INDEX].probability.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Probability","uniqueKey":"\\items.items.[INDEX].probability.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].probability","typeLabel":"integer | null"},"source_date":{"oneOf":[{"type":"string","title":"Source Date","uniqueKey":"\\items.items.[INDEX].source_date.oneOf.0","typeLabel":"string"},{"type":"null","title":"Source Date","uniqueKey":"\\items.items.[INDEX].source_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].source_date","typeLabel":"string | null"},"stage":{"oneOf":[{"type":"object","title":"OpportunityStageOnRecord","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].stage.oneOf.0.uuid","typeLabel":"string"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].stage.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].stage.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].stage.oneOf.0.name","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].stage.oneOf.0","typeLabel":"OpportunityStageOnRecord · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].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":"\\items.items.[INDEX].type.oneOf.0.label","typeLabel":"string"},"label_plural":{"title":"Label Plural","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].type.oneOf.0.label_plural","typeLabel":"string"},"sub_label":{"title":"Sub Label","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].type.oneOf.0.sub_label","typeLabel":"string"},"sub_label_plural":{"title":"Sub Label Plural","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].type.oneOf.0.sub_label_plural","typeLabel":"string"},"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].type.oneOf.0.uuid","typeLabel":"string"},"is_hidden":{"oneOf":[{"type":"boolean","title":"Is Hidden","uniqueKey":"\\items.items.[INDEX].type.oneOf.0.is_hidden.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Hidden","uniqueKey":"\\items.items.[INDEX].type.oneOf.0.is_hidden.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].type.oneOf.0.is_hidden","typeLabel":"boolean | null"}},"uniqueKey":"\\items.items.[INDEX].type.oneOf.0","typeLabel":"OpportunityTypeOnRecord · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].type","typeLabel":"OpportunityTypeOnRecord · object | null"},"updated_at":{"oneOf":[{"type":"number","title":"Updated At","uniqueKey":"\\items.items.[INDEX].updated_at.oneOf.0","typeLabel":"number"},{"type":"null","title":"Updated At","uniqueKey":"\\items.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].updated_at","typeLabel":"number | null"},"updated_by":{"oneOf":[{"type":"object","title":"RelatedPerson","required":["uuid"],"properties":{"uuid":{"title":"Uuid","type":"string","isRequired":true,"uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.uuid","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.logo_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Logo Url","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.logo_url","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","title":"Name","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.name","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","title":"Type","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.type.oneOf.0","typeLabel":"string"},{"type":"null","title":"Type","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0.type","typeLabel":"string | null"}},"uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.0","typeLabel":"RelatedPerson · object"},{"type":"null","uniqueKey":"\\items.items.[INDEX].updated_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].updated_by","typeLabel":"RelatedPerson · object | null"},"value":{"oneOf":[{"type":"integer","title":"Value","uniqueKey":"\\items.items.[INDEX].value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Value","uniqueKey":"\\items.items.[INDEX].value.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].value","typeLabel":"integer | null"},"weighted_value":{"oneOf":[{"type":"integer","title":"Weighted Value","uniqueKey":"\\items.items.[INDEX].weighted_value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Weighted Value","uniqueKey":"\\items.items.[INDEX].weighted_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].weighted_value","typeLabel":"integer | null"}},"required":["uuid"],"title":"OpportunityResponse","type":"object","uniqueKey":"\\items.items.[INDEX]","typeLabel":"OpportunityResponse · object"},"title":"Items","type":"array","isRequired":true,"uniqueKey":"\\items","typeLabel":"OpportunityResponse · object[]"},"page":{"title":"Page","type":"integer","isRequired":true,"uniqueKey":"page","typeLabel":"integer"},"per_page":{"title":"Per Page","type":"integer","isRequired":true,"uniqueKey":"per_page","typeLabel":"integer"},"total":{"oneOf":[{"type":"integer","title":"Total","isRequired":true,"uniqueKey":"total.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total","isRequired":true,"uniqueKey":"total.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"total","typeLabel":"integer | 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"},"has_more":{"oneOf":[{"type":"boolean","title":"Has More","uniqueKey":"has_more.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Has More","uniqueKey":"has_more.oneOf.1","typeLabel":"null"}],"uniqueKey":"has_more","typeLabel":"boolean | null"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","uniqueKey":"next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","uniqueKey":"next_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"next_cursor","typeLabel":"string | null"},"total_value":{"oneOf":[{"type":"integer","title":"Total Value","uniqueKey":"total_value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total Value","uniqueKey":"total_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_value","typeLabel":"integer | null"},"total_weighted_value":{"oneOf":[{"type":"integer","title":"Total Weighted Value","uniqueKey":"total_weighted_value.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Total Weighted Value","uniqueKey":"total_weighted_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"total_weighted_value","typeLabel":"integer | null"}},"required":["items","page","per_page","total"],"title":"OpportunityListResponse","type":"object","uniqueKey":"","typeLabel":"OpportunityListResponse · object"},"examples":{"Example":{"title":"Example","value":{"items":[{"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_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}],"page":123,"per_page":123,"total":123,"custom_field_mapping":{"fields":[{"key":"\u003cstring>","name":"\u003cstring>","type":"\u003cstring>","uuid":"\u003cstring>","choices":["\u003cstring>"]}],"standard_key_to_uuid":{},"unresolved_keys":["\u003cstring>"]},"has_more":true,"next_cursor":"\u003cstring>","total_value":123,"total_weighted_value":123}}},"exampleType":"generated"}},"description":"Paginated list of opportunities.","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":"List opportunities - Rings AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-02T07:52:37.511Z","originalFileLocation":"api-reference/opportunity/list-opportunities.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 a paginated list of opportunities visible to the tenant ring. Filter parameters (all optional): - name: Case-insensitive substring match on the opportunity\u0026#x27;s own name - search: Search name and associated person/company names. All words must match, in any order; falls back to fuzzy matching when nothing does. Does not search the opportunity type label - opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type name, including a sub-label, with GET /v1/opportunity-types - opportunity_stage_uuid: Filter by a single stage UUID - opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage names aren\u0026#x27;t accepted; the parameter description explains how to resolve one, including names shared by several stages - owner_user_uuid: Comma-separated owner UUID(s); accepts either a user UUID or the person UUID shown as owner.uuid on a record. Returns 400 if none of them resolve to a user in this tenant - include_no_owner: Widens owner_user_uuid to also match opportunities with no owner; no effect unless owner_user_uuid is set - has_owner: true for only owned opportunities, false for only unassigned ones; omit for both - intro_person_uuid: Filter by the intro person\u0026#x27;s UUID - related_company_uuid / related_person_uuid: parent opportunities that have a sub-opportunity associated with this entity - parent_uuid: Return only sub-opportunities of this parent UUID - hierarchy_type: \u0026#x27;PARENT\u0026#x27; or \u0026#x27;CHILD\u0026#x27; (ignored if parent_uuid is set) - company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities associated with any of them - city / state / country: Where an associated person or company is based — this is how you answer \u0026quot;which of my deals are in LA\u0026quot;. They AND together and must all match the same associated entity. Spell the state out (\u0026#x27;Florida\u0026#x27;), or pass a two-letter code with country (\u0026#x27;FL\u0026#x27; + \u0026#x27;US\u0026#x27;); a code alone returns 400, since unscoped \u0026#x27;FL\u0026#x27; resolves to Flintshire, GB - value_from / value_to, probability_from / probability_to: inclusive range filters - updated_after / updated_before: ISO 8601 date/datetime range on updated_at - source_date_from / source_date_to: ISO 8601 dates, required together - close_date_from / close_date_to: ISO 8601 dates, required together; opportunities with no close_date are excluded - last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required together - next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required together; an associated person or company has its next meeting in range - include_no_next_meeting: true for only opportunities with no meeting scheduled with any associated person or company; overrides next_meeting_at_from / next_meeting_at_to - days_in_stage_from / days_in_stage_to: inclusive range on days since the most recent stage change; either end may be omitted Sort parameters: - sort_by: name | created_at | updated_at | value | weighted_value | probability | source_date | intro_date | close_date | last_activity_date | details | next_step | stage | owner | intro_person | days_in_stage | notes_and_files_count - order: asc | desc (default: asc) Pagination: - page: Page number (default: 1) - per_page: Results per page (default: 10) The response also includes total_value/total_weighted_value: sums of value/weighted_value across the full filtered set, not just the page.\">\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=\"List opportunities - Rings AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a paginated list of opportunities visible to the tenant ring. Filter parameters (all optional): - name: Case-insensitive substring match on the opportunity\u0026#x27;s own name - search: Search name and associated person/company names. All words must match, in any order; falls back to fuzzy matching when nothing does. Does not search the opportunity type label - opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type name, including a sub-label, with GET /v1/opportunity-types - opportunity_stage_uuid: Filter by a single stage UUID - opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage names aren\u0026#x27;t accepted; the parameter description explains how to resolve one, including names shared by several stages - owner_user_uuid: Comma-separated owner UUID(s); accepts either a user UUID or the person UUID shown as owner.uuid on a record. Returns 400 if none of them resolve to a user in this tenant - include_no_owner: Widens owner_user_uuid to also match opportunities with no owner; no effect unless owner_user_uuid is set - has_owner: true for only owned opportunities, false for only unassigned ones; omit for both - intro_person_uuid: Filter by the intro person\u0026#x27;s UUID - related_company_uuid / related_person_uuid: parent opportunities that have a sub-opportunity associated with this entity - parent_uuid: Return only sub-opportunities of this parent UUID - hierarchy_type: \u0026#x27;PARENT\u0026#x27; or \u0026#x27;CHILD\u0026#x27; (ignored if parent_uuid is set) - company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities associated with any of them - city / state / country: Where an associated person or company is based — this is how you answer \u0026quot;which of my deals are in LA\u0026quot;. They AND together and must all match the same associated entity. Spell the state out (\u0026#x27;Florida\u0026#x27;), or pass a two-letter code with country (\u0026#x27;FL\u0026#x27; + \u0026#x27;US\u0026#x27;); a code alone returns 400, since unscoped \u0026#x27;FL\u0026#x27; resolves to Flintshire, GB - value_from / value_to, probability_from / probability_to: inclusive range filters - updated_after / updated_before: ISO 8601 date/datetime range on updated_at - source_date_from / source_date_to: ISO 8601 dates, required together - close_date_from / close_date_to: ISO 8601 dates, required together; opportunities with no close_date are excluded - last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required together - next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required together; an associated person or company has its next meeting in range - include_no_next_meeting: true for only opportunities with no meeting scheduled with any associated person or company; overrides next_meeting_at_from / next_meeting_at_to - days_in_stage_from / days_in_stage_to: inclusive range on days since the most recent stage change; either end may be omitted Sort parameters: - sort_by: name | created_at | updated_at | value | weighted_value | probability | source_date | intro_date | close_date | last_activity_date | details | next_step | stage | owner | intro_person | days_in_stage | notes_and_files_count - order: asc | desc (default: asc) Pagination: - page: Page number (default: 1) - per_page: Results per page (default: 10) The response also includes total_value/total_weighted_value: sums of value/weighted_value across the full filtered set, not just the page.\">\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/list-opportunities\">\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=List+opportunities\u0026amp;description=%0AReturns+a+paginated+list+of+opportunities+visible+to+the+tenant+ring.%0A%0AFilter+parameters+%28all+optional%29%3A%0A-+name%3A+Case-insensitive+substring+match+on+the+opport\u0026amp;theme=2e1657476a2935937e03de5f\u0026amp;signature=1acfb11678875eec270aeb86443034fcab8e32773e5f5795311cbd4961cf91fb\">\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=\"List opportunities - Rings AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a paginated list of opportunities visible to the tenant ring. Filter parameters (all optional): - name: Case-insensitive substring match on the opportunity\u0026#x27;s own name - search: Search name and associated person/company names. All words must match, in any order; falls back to fuzzy matching when nothing does. Does not search the opportunity type label - opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type name, including a sub-label, with GET /v1/opportunity-types - opportunity_stage_uuid: Filter by a single stage UUID - opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage names aren\u0026#x27;t accepted; the parameter description explains how to resolve one, including names shared by several stages - owner_user_uuid: Comma-separated owner UUID(s); accepts either a user UUID or the person UUID shown as owner.uuid on a record. Returns 400 if none of them resolve to a user in this tenant - include_no_owner: Widens owner_user_uuid to also match opportunities with no owner; no effect unless owner_user_uuid is set - has_owner: true for only owned opportunities, false for only unassigned ones; omit for both - intro_person_uuid: Filter by the intro person\u0026#x27;s UUID - related_company_uuid / related_person_uuid: parent opportunities that have a sub-opportunity associated with this entity - parent_uuid: Return only sub-opportunities of this parent UUID - hierarchy_type: \u0026#x27;PARENT\u0026#x27; or \u0026#x27;CHILD\u0026#x27; (ignored if parent_uuid is set) - company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities associated with any of them - city / state / country: Where an associated person or company is based — this is how you answer \u0026quot;which of my deals are in LA\u0026quot;. They AND together and must all match the same associated entity. Spell the state out (\u0026#x27;Florida\u0026#x27;), or pass a two-letter code with country (\u0026#x27;FL\u0026#x27; + \u0026#x27;US\u0026#x27;); a code alone returns 400, since unscoped \u0026#x27;FL\u0026#x27; resolves to Flintshire, GB - value_from / value_to, probability_from / probability_to: inclusive range filters - updated_after / updated_before: ISO 8601 date/datetime range on updated_at - source_date_from / source_date_to: ISO 8601 dates, required together - close_date_from / close_date_to: ISO 8601 dates, required together; opportunities with no close_date are excluded - last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required together - next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required together; an associated person or company has its next meeting in range - include_no_next_meeting: true for only opportunities with no meeting scheduled with any associated person or company; overrides next_meeting_at_from / next_meeting_at_to - days_in_stage_from / days_in_stage_to: inclusive range on days since the most recent stage change; either end may be omitted Sort parameters: - sort_by: name | created_at | updated_at | value | weighted_value | probability | source_date | intro_date | close_date | last_activity_date | details | next_step | stage | owner | intro_person | days_in_stage | notes_and_files_count - order: asc | desc (default: asc) Pagination: - page: Page number (default: 1) - per_page: Results per page (default: 10) The response also includes total_value/total_weighted_value: sums of value/weighted_value across the full filtered set, not just the page.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rings-ai.mintlify.app/_mintlify/api/og/v2?division=Opportunity\u0026amp;title=List+opportunities\u0026amp;description=%0AReturns+a+paginated+list+of+opportunities+visible+to+the+tenant+ring.%0A%0AFilter+parameters+%28all+optional%29%3A%0A-+name%3A+Case-insensitive+substring+match+on+the+opport\u0026amp;theme=2e1657476a2935937e03de5f\u0026amp;signature=1acfb11678875eec270aeb86443034fcab8e32773e5f5795311cbd4961cf91fb\">\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/list-opportunities\">\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/list-opportunities.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/list-opportunities#webpage\",\"url\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities\",\"name\":\"List opportunities\",\"description\":\"Returns a paginated list of opportunities visible to the tenant ring. Filter parameters (all optional): - name: Case-insensitive substring match on the opportunity's own name - search: Search name and associated person/company names. All words must match, in any order; falls back to fuzzy matching when nothing does. Does not search the opportunity type label - opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type name, including a sub-label, with GET /v1/opportunity-types - opportunity_stage_uuid: Filter by a single stage UUID - opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage names aren't accepted; the parameter description explains how to resolve one, including names shared by several stages - owner_user_uuid: Comma-separated owner UUID(s); accepts either a user UUID or the person UUID shown as owner.uuid on a record. Returns 400 if none of them resolve to a user in this tenant - include_no_owner: Widens owner_user_uuid to also match opportunities with no owner; no effect unless owner_user_uuid is set - has_owner: true for only owned opportunities, false for only unassigned ones; omit for both - intro_person_uuid: Filter by the intro person's UUID - related_company_uuid / related_person_uuid: parent opportunities that have a sub-opportunity associated with this entity - parent_uuid: Return only sub-opportunities of this parent UUID - hierarchy_type: 'PARENT' or 'CHILD' (ignored if parent_uuid is set) - company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities associated with any of them - city / state / country: Where an associated person or company is based — this is how you answer \\\"which of my deals are in LA\\\". They AND together and must all match the same associated entity. Spell the state out ('Florida'), or pass a two-letter code with country ('FL' + 'US'); a code alone returns 400, since unscoped 'FL' resolves to Flintshire, GB - value_from / value_to, probability_from / probability_to: inclusive range filters - updated_after / updated_before: ISO 8601 date/datetime range on updated_at - source_date_from / source_date_to: ISO 8601 dates, required together - close_date_from / close_date_to: ISO 8601 dates, required together; opportunities with no close_date are excluded - last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required together - next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required together; an associated person or company has its next meeting in range - include_no_next_meeting: true for only opportunities with no meeting scheduled with any associated person or company; overrides next_meeting_at_from / next_meeting_at_to - days_in_stage_from / days_in_stage_to: inclusive range on days since the most recent stage change; either end may be omitted Sort parameters: - sort_by: name | created_at | updated_at | value | weighted_value | probability | source_date | intro_date | close_date | last_activity_date | details | next_step | stage | owner | intro_person | days_in_stage | notes_and_files_count - order: asc | desc (default: asc) Pagination: - page: Page number (default: 1) - per_page: Results per page (default: 10) The response also includes total_value/total_weighted_value: sums of value/weighted_value across the full filtered set, not just the page.\",\"dateModified\":\"2026-10-02T07:52:37.511Z\",\"isPartOf\":{\"@id\":\"https://docs.rings.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Rings AI\",\"item\":\"https://docs.rings.ai\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List opportunities\",\"item\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities#apireference\",\"headline\":\"List opportunities\",\"name\":\"List opportunities\",\"description\":\"Returns a paginated list of opportunities visible to the tenant ring. Filter parameters (all optional): - name: Case-insensitive substring match on the opportunity's own name - search: Search name and associated person/company names. All words must match, in any order; falls back to fuzzy matching when nothing does. Does not search the opportunity type label - opportunity_type_uuid: Filter by opportunity type UUID. Resolve a type name, including a sub-label, with GET /v1/opportunity-types - opportunity_stage_uuid: Filter by a single stage UUID - opportunity_stage_uuids: Comma-separated stage UUIDs (IN filter). Stage names aren't accepted; the parameter description explains how to resolve one, including names shared by several stages - owner_user_uuid: Comma-separated owner UUID(s); accepts either a user UUID or the person UUID shown as owner.uuid on a record. Returns 400 if none of them resolve to a user in this tenant - include_no_owner: Widens owner_user_uuid to also match opportunities with no owner; no effect unless owner_user_uuid is set - has_owner: true for only owned opportunities, false for only unassigned ones; omit for both - intro_person_uuid: Filter by the intro person's UUID - related_company_uuid / related_person_uuid: parent opportunities that have a sub-opportunity associated with this entity - parent_uuid: Return only sub-opportunities of this parent UUID - hierarchy_type: 'PARENT' or 'CHILD' (ignored if parent_uuid is set) - company_uuid / person_uuid: Comma-separated UUID(s); union of opportunities associated with any of them - city / state / country: Where an associated person or company is based — this is how you answer \\\"which of my deals are in LA\\\". They AND together and must all match the same associated entity. Spell the state out ('Florida'), or pass a two-letter code with country ('FL' + 'US'); a code alone returns 400, since unscoped 'FL' resolves to Flintshire, GB - value_from / value_to, probability_from / probability_to: inclusive range filters - updated_after / updated_before: ISO 8601 date/datetime range on updated_at - source_date_from / source_date_to: ISO 8601 dates, required together - close_date_from / close_date_to: ISO 8601 dates, required together; opportunities with no close_date are excluded - last_activity_date_from / last_activity_date_to: ISO 8601 datetimes, required together - next_meeting_at_from / next_meeting_at_to: ISO 8601 datetimes, required together; an associated person or company has its next meeting in range - include_no_next_meeting: true for only opportunities with no meeting scheduled with any associated person or company; overrides next_meeting_at_from / next_meeting_at_to - days_in_stage_from / days_in_stage_to: inclusive range on days since the most recent stage change; either end may be omitted Sort parameters: - sort_by: name | created_at | updated_at | value | weighted_value | probability | source_date | intro_date | close_date | last_activity_date | details | next_step | stage | owner | intro_person | days_in_stage | notes_and_files_count - order: asc | desc (default: asc) Pagination: - page: Page number (default: 1) - per_page: Results per page (default: 10) The response also includes total_value/total_weighted_value: sums of value/weighted_value across the full filtered set, not just the page.\",\"url\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rings.ai/api-reference/opportunity/list-opportunities#webpage\"},\"dateModified\":\"2026-10-02T07:52:37.511Z\",\"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","description":"\nEach entry in `queries` is resolved independently using the same matching\nsemantics as `GET /v1/companies/lookup`. Results are returned in the same\norder as the input.","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}","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":"List opportunities - 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"]}