Returns one email thread or meeting with every stored field: all messages and bodies for an
email, the transcript and analysis for a meeting, its labels, and the records it is linked to.
A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.
A synced email thread (channel.typeemail) or calendar meeting (channel.typemeeting). Heliyos stores the provider's data and adds AI analysis. Fields depend on the channel and on how far the analysis has got; treat every field except _id, organizationId and channel as optional, and ignore fields you do not recognise.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Heliyos","description":"Developer docs for Heliyos, the AI operating system for revenue. Build on its unified customer memory and AI workers with the REST API and the MCP server.","colors":{"primary":"#27251E","light":"#FFD037","dark":"#27251E"},"logo":{"light":"https://mintcdn.com/heliyos/j131RqihzUCqTT55/logo/light.png?fit=max\u0026auto=format\u0026n=j131RqihzUCqTT55\u0026q=85\u0026s=b4ac5cbb6af42223e13e9abe4295155d","dark":"https://mintcdn.com/heliyos/j131RqihzUCqTT55/logo/dark.png?fit=max\u0026auto=format\u0026n=j131RqihzUCqTT55\u0026q=85\u0026s=e6755b09abefd37df8199b6a504a8a54","href":"https://www.heliyos.ai"},"favicon":"https://mintcdn.com/heliyos/j131RqihzUCqTT55/favicon.png?fit=max\u0026auto=format\u0026n=j131RqihzUCqTT55\u0026q=85\u0026s=13f98b158bbf66355eb23e7f3b0468a1","api":{"params":{"expanded":"closed"},"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","python"]}},"appearance":{"default":"system","strict":false},"background":{"color":{"light":"#FAF7F3","dark":"#1E1C17"}},"navbar":{"links":[{"icon":"brand-github","href":"https://github.com/heliyos-ai","label":"GitHub"},{"icon":"brand-linkedin","href":"https://www.linkedin.com/company/heliyos","label":"LinkedIn"}],"primary":{"type":"button","label":"Join waitlist","href":"https://www.heliyos.ai"}},"seo":{"metatags":{"og:site_name":"Heliyos","og:locale":"en_US","og:type":"website","og:image":"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg","og:image:width":"1200","og:image:height":"630","og:image:alt":"Heliyos: The AI operating system for revenue","twitter:card":"summary_large_image","twitter:image":"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg","twitter:image:alt":"Heliyos: The AI operating system for revenue","keywords":"Heliyos API, Heliyos MCP server, AI operating system for revenue, AI workers, customer memory, CRM API, MCP server for sales","canonical":"https://docs.heliyos.ai"},"organization":{"id":"https://www.heliyos.ai/#organization","name":"Heliyos","url":"https://www.heliyos.ai","logo":"https://www.heliyos.ai/assets/brand/logo-color.png","sameAs":["https://www.heliyos.ai","https://www.linkedin.com/company/heliyos","https://github.com/heliyos-ai","https://www.npmjs.com/package/@heliyos/mcp"]},"indexing":"navigable"},"fonts":{"family":"Geist","source":"fonts/Geist-Variable.woff2","format":"woff2"},"icons":{"library":"tabler"},"styling":{"eyebrows":"section","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","vscode"],"display":"header"},"thumbnails":{"preset":"headline","appearance":"light","surface":"neutral"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heliyos","hasAudioNarration":false,"actualSubdomain":"heliyos","customDomains":["docs.heliyos.ai"],"gitSource":{"type":"github","owner":"heliyos-ai","repo":"heliyos-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6aec32751dd5aac17d4d14c7"},"chroma":{"latestBuiltDeploymentHistoryId":"6aecaf0264441d6863c94524","collectionId":"5c85d994-5da1-4fb6-b1f0-7110b5fe061b","liveDeploymentHistoryId":"6aecaf0264441d6863c94524","schemaVersion":"v3"},"feedback":{"thumbs":true,"edits":false,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aecb2311f2bb168c88a68bb","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API reference","count":78},{"language":"default","tag":"MCP server","count":22},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Guides","count":14},{"language":"default","tag":"Workers and runs","count":10},{"language":"default","tag":"Scouts","count":9},{"language":"default","tag":"Get started","count":7},{"language":"default","tag":"Files","count":6},{"language":"default","tag":"Records","count":6},{"language":"default","tag":"Tasks","count":6}],"searchSettings":{"showContentSnippets":true,"fullPageSearch":true,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@font-face{font-family:\"Gambetta\";src:url(\"/fonts/Gambetta-Regular.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Gambetta\";src:url(\"/fonts/Gambetta-Italic.woff2\") format(\"woff2\");font-weight:400;font-style:italic;font-display:swap}@font-face{font-family:\"Geist\";src:url(\"/fonts/Geist-Variable.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}@font-face{font-family:\"Geist Mono\";src:url(\"/fonts/GeistMono-Variable.woff2\") format(\"woff2\");font-weight:100 900;font-style:normal;font-display:swap}:root{--hy-canvas: #FAF7F3;--hy-surface: #FEFDFB;--hy-zone: #F3EEE6;--hy-line: #E1DCD3;--hy-line-strong: #D1CBC2;--hy-text: #27251E;--hy-text-body: #4A4742;--hy-text-muted: #6D6A64;--hy-code-bg: #27251E;--hy-code-line: #3A372F;--hy-sun: #FFD037;--hy-sun-soft: #FFE58F;--hy-sun-wash: #FBF1C7;--hy-sun-deep: #EBB427;--hy-sun-ink: #815C0A;--hy-ink: #14120F;--hy-icon-filter: none;--hy-get-bg: #E5F5E7;--hy-get-fg: #287C42;--hy-get-edge: #B6DDBD;--hy-post-bg: #E5F2FF;--hy-post-fg: #2D5277;--hy-post-edge: #BBD6F3;--hy-put-bg: #F4ECFE;--hy-put-fg: #594571;--hy-put-edge: #DACBEE;--hy-patch-bg: #FFECDC;--hy-patch-fg: #9C5313;--hy-patch-edge: #F6C6A0;--hy-del-bg: #FFEAE7;--hy-del-fg: #B8433A;--hy-del-edge: #F6C3BB;--hy-warn-bg: #FFECDC;--hy-warn-fg: #9C5313;--hy-warn-edge: #F6C6A0;--hy-ok-bg: #E5F5E7;--hy-ok-fg: #287C42;--hy-ok-edge: #B6DDBD;--hy-bad-bg: #FFEAE7;--hy-bad-fg: #B8433A;--hy-bad-edge: #F6C3BB}html.dark{--hy-canvas: #1E1C17;--hy-surface: #27251E;--hy-zone: #3A372F;--hy-line: #3A372F;--hy-line-strong: #4A4742;--hy-text: #F3EEE6;--hy-text-body: #EBE5DB;--hy-text-muted: #A9A49B;--hy-code-bg: #14120F;--hy-code-line: #3A372F;--hy-sun-ink: #FFE58F;--hy-icon-filter: invert(0.93) sepia(0.08);--hy-get-bg: rgba(60, 154, 88, 0.18);--hy-get-fg: #B6DDBD;--hy-get-edge: rgba(60, 154, 88, 0.45);--hy-post-bg: rgba(85, 138, 192, 0.2);--hy-post-fg: #BBD6F3;--hy-post-edge: rgba(85, 138, 192, 0.5);--hy-put-bg: rgba(148, 118, 183, 0.2);--hy-put-fg: #DACBEE;--hy-put-edge: rgba(148, 118, 183, 0.5);--hy-patch-bg: rgba(219, 125, 36, 0.18);--hy-patch-fg: #F6C6A0;--hy-patch-edge: rgba(219, 125, 36, 0.45);--hy-del-bg: rgba(208, 90, 79, 0.2);--hy-del-fg: #F6C3BB;--hy-del-edge: rgba(208, 90, 79, 0.5);--hy-warn-bg: rgba(219, 125, 36, 0.14);--hy-warn-fg: #F6C6A0;--hy-warn-edge: rgba(219, 125, 36, 0.4);--hy-ok-bg: rgba(60, 154, 88, 0.14);--hy-ok-fg: #B6DDBD;--hy-ok-edge: rgba(60, 154, 88, 0.4);--hy-bad-bg: rgba(208, 90, 79, 0.16);--hy-bad-fg: #F6C3BB;--hy-bad-edge: rgba(208, 90, 79, 0.45)}body,button,input,select,textarea{font-family:\"Geist\", system-ui, sans-serif}code,pre,kbd,.font-mono{font-family:\"Geist Mono\", ui-monospace, monospace!important}body{background:var(--hy-canvas)!important;color:var(--hy-text)}.prose{color:var(--hy-text-body)}.prose h1,.prose h2,.prose h3,.prose h4,.prose strong,#page-title{color:var(--hy-text)!important}.prose h2{letter-spacing:-0.01em}.prose a:not([class]){color:var(--hy-text);font-weight:500;text-decoration:underline;text-decoration-color:var(--hy-sun-deep);text-decoration-thickness:2px;text-underline-offset:3px;border-bottom:none}.prose a:not([class]):hover{text-decoration-color:var(--hy-text)}img[src^=\"/icons/\"]{filter:var(--hy-icon-filter)}.nav-tabs-item{color:var(--hy-text-muted)!important}.nav-tabs-item:hover{color:var(--hy-text)!important}.nav-tabs-item[data-active=\"true\"]{color:var(--hy-text)!important;font-weight:600}.nav-tabs-item [class*=\"bottom-0\"][class*=\"bg-primary\"]{background:var(--hy-sun-deep)!important;height:2px!important;border-radius:2px}#sidebar-content a{border-radius:8px;transition:background-color .12s ease}#sidebar-content a:not([aria-current=\"page\"]):hover{background:var(--hy-zone);color:var(--hy-text)!important}#sidebar-content a[aria-current=\"page\"]{background:var(--hy-sun-deep)!important;color:var(--hy-ink)!important;border-color:var(--hy-sun-deep)!important;font-weight:600;text-shadow:none!important}#sidebar-content a[aria-current=\"page\"] img[src^=\"/icons/\"]{filter:none}#sidebar-content a[aria-current=\"page\"] [class*=\"bg-[#\"]{background:var(--hy-ink)!important;color:var(--hy-sun)!important;box-shadow:none}[class*=\"bg-green-400/20\"]{background:var(--hy-get-bg)!important;color:var(--hy-get-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-get-edge)}[class*=\"bg-blue-400/20\"]{background:var(--hy-post-bg)!important;color:var(--hy-post-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-post-edge)}[class*=\"bg-purple-400/20\"],[class*=\"bg-yellow-400/20\"]{background:var(--hy-put-bg)!important;color:var(--hy-put-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-put-edge)}[class*=\"bg-orange-400/20\"]{background:var(--hy-patch-bg)!important;color:var(--hy-patch-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-patch-edge)}[class*=\"bg-red-400/20\"]{background:var(--hy-del-bg)!important;color:var(--hy-del-fg)!important;box-shadow:inset 0 0 0 1px var(--hy-del-edge)}.method-pill{letter-spacing:0.02em}.card{background:var(--hy-surface)!important;border-color:var(--hy-line)!important;border-radius:16px!important;box-shadow:none!important;transition:border-color .15s ease, box-shadow .15s ease}.card:hover{border-color:var(--hy-sun-deep)!important;box-shadow:0 8px 24px -8px rgba(39,37,30,.18), 0 2px 4px rgba(39,37,30,.05)!important}.card [class*=\"size-6\"]:has(>img){width:40px!important;height:40px!important;display:grid;place-items:center;background:var(--hy-sun-wash);border:1px solid var(--hy-sun-soft);border-radius:10px}html.dark .card [class*=\"size-6\"]:has(>img){background:rgba(255, 208, 55, 0.12);border-color:rgba(255, 208, 55, 0.3)}.card [class*=\"size-6\"]:has(>img) img{width:22px!important;height:22px!important}.card h2{color:var(--hy-text)!important}.prose :not(pre)>code{background:var(--hy-zone);border:1px solid var(--hy-line);border-radius:7px;padding:1px 6px;color:var(--hy-text);font-size:0.875em}.code-block,[class*=\"code-block\"]{background:var(--hy-code-bg)!important;border-color:var(--hy-code-line)!important;border-radius:12px!important}.prose table{border-color:var(--hy-line)}.prose thead th{background:var(--hy-zone);color:var(--hy-text-muted);font-family:\"Geist Mono\", ui-monospace, monospace;font-size:11px;font-weight:500;letter-spacing:0.04em;text-transform:uppercase}.prose td,.prose th{border-color:var(--hy-line)}.callout{border-radius:12px!important}.callout[data-callout-type=\"note\"],.callout[data-callout-type=\"info\"]{background:var(--hy-sun-wash)!important;border-color:var(--hy-sun-soft)!important;color:var(--hy-text)!important;box-shadow:inset 3px 0 0 var(--hy-sun-deep)}html.dark .callout[data-callout-type=\"note\"],html.dark .callout[data-callout-type=\"info\"]{background:rgba(255,208,55,0.10)!important;border-color:rgba(255,208,55,0.3)!important}.callout[data-callout-type=\"warning\"]{background:var(--hy-warn-bg)!important;border-color:var(--hy-warn-edge)!important;color:var(--hy-warn-fg)!important}.callout[data-callout-type=\"tip\"],.callout[data-callout-type=\"check\"]{background:var(--hy-ok-bg)!important;border-color:var(--hy-ok-edge)!important;color:var(--hy-ok-fg)!important}.callout[data-callout-type=\"danger\"]{background:var(--hy-bad-bg)!important;border-color:var(--hy-bad-edge)!important;color:var(--hy-bad-fg)!important}.callout *{color:inherit}.callout code{background:rgba(255,255,255,.55)!important}html.dark .callout code{background:rgba(0,0,0,.25)!important}.tryit-button{background:var(--hy-sun)!important;color:var(--hy-ink)!important;font-weight:600;border:1px solid var(--hy-sun-deep);border-radius:8px!important;box-shadow:inset 0 1px 0 rgba(255,255,255,.35), 0 1px 2px rgba(20,18,15,.28)}.tryit-button:hover{opacity:1!important;background:var(--hy-sun-deep)!important}.tryit-button svg,.tryit-button path{fill:var(--hy-ink)!important;color:var(--hy-ink)!important}#navbar ul>li:not(.navbar-link)>a{background:linear-gradient(180deg, #3A372F, #27251E);color:#F3EEE6!important;border:1px solid #14120F;border-radius:8px;padding:6px 12px;box-shadow:inset 0 1px 0 rgba(255,255,255,.16), 0 1px 2px rgba(20,18,15,.28)}#navbar ul>li:not(.navbar-link)>a *{color:inherit!important}html.dark #navbar ul>li:not(.navbar-link)>a{background:var(--hy-sun);color:var(--hy-ink)!important;border-color:var(--hy-sun-deep)}#navbar ul>li:not(.navbar-link)>a>span[class*=\"absolute\"]{background:transparent!important}a:focus-visible,button:focus-visible,[role=\"tab\"]:focus-visible{outline:none;box-shadow:0 0 0 2px var(--hy-canvas), 0 0 0 4px var(--hy-text)!important;border-radius:8px}body:has(.hy-hero) #header{display:none}.hy-hero{padding:8px 0 24px}.hy-eyebrow{display:inline-flex;align-items:center;gap:8px;font-family:\"Geist Mono\", ui-monospace, monospace;font-size:11px;font-weight:500;letter-spacing:0.05em;color:var(--hy-sun-ink);margin:0 0 16px;background:var(--hy-sun-wash);border:1px solid var(--hy-sun-soft);border-radius:999px;padding:4px 10px}html.dark .hy-eyebrow{background:rgba(255,208,55,0.12);border-color:rgba(255,208,55,0.3)}.hy-display{font-family:\"Gambetta\", Georgia, serif!important;font-weight:400!important;font-size:56px!important;line-height:1.05;letter-spacing:-0.02em;color:var(--hy-text)!important;margin:0 0 16px}.hy-display em{font-style:italic}.hy-lede{font-size:17px;line-height:1.6;color:var(--hy-text-body);max-width:720px;margin:0}@media (max-width: 640px){.hy-display{font-size:40px!important;line-height:1.1;letter-spacing:-0.015em}}@media (prefers-reduced-motion: reduce){*,*::before,*::after{animation:none!important;transition:none!important}}[class*=\"group/step-indicator\"]{background:var(--hy-sun)!important;color:var(--hy-ink)!important;box-shadow:inset 0 0 0 1px var(--hy-sun-deep)}.steps [class*=\"border-l\"],.steps [class*=\"w-px\"]{border-color:var(--hy-sun-soft)!important;background-color:var(--hy-sun-soft)}html.dark .steps [class*=\"border-l\"],html.dark .steps [class*=\"w-px\"]{border-color:rgba(255,208,55,0.3)!important;background-color:rgba(255,208,55,0.3)}#sidebar-content ul.sidebar-group>li>a{margin-left:22px}#sidebar-content .sidebar-group-header{color:var(--hy-text)!important;font-weight:600}.hy-picker{margin:24px 0;border:1px solid var(--hy-line);border-radius:16px;background:var(--hy-surface);overflow:hidden}.hy-picker-tabs{display:grid;grid-template-columns:repeat(auto-fit, minmax(150px, 1fr));border-bottom:1px solid var(--hy-line)}.hy-picker-tab{display:flex;align-items:center;gap:10px;padding:14px 16px;text-align:left;cursor:pointer;background:transparent;border:0;border-right:1px solid var(--hy-line);border-bottom:1px solid var(--hy-line);margin-bottom:-1px;box-shadow:inset 0 2px 0 transparent;transition:background-color .12s ease}.hy-picker-tab:hover{background:var(--hy-zone)}.hy-picker-tab.is-active{background:var(--hy-sun-wash);box-shadow:inset 0 2px 0 var(--hy-sun-deep)}html.dark .hy-picker-tab.is-active{background:rgba(255,208,55,0.12)}.hy-picker-logo{width:32px;height:32px;flex-shrink:0;display:grid;place-items:center;background:#FEFDFB;border:1px solid #E1DCD3;border-radius:8px}.hy-picker-logo img{width:18px;height:18px;filter:none!important}.hy-picker-label{display:flex;flex-direction:column;min-width:0}.hy-picker-name{font-size:14px;font-weight:600;color:var(--hy-text)}.hy-picker-hint{font-size:12px;color:var(--hy-text-muted)}.hy-picker-panel{padding:8px 20px 12px}.hy-picker-step{display:flex;gap:14px;padding:14px 0;border-top:1px solid var(--hy-line)}.hy-picker-step:first-child{border-top:0}.hy-picker-num{width:24px;height:24px;flex-shrink:0;border-radius:999px;display:grid;place-items:center;background:var(--hy-sun);color:var(--hy-ink);font-size:12px;font-weight:600;box-shadow:inset 0 0 0 1px var(--hy-sun-deep)}.hy-picker-body{flex:1;min-width:0}.hy-picker-title{margin:2px 0 4px;font-size:14px;font-weight:600;color:var(--hy-text)}.hy-picker-text{margin:0 0 8px;font-size:14px;line-height:1.5;color:var(--hy-text-body)}.hy-picker-code{position:relative}.hy-picker-code pre{margin:0;padding:14px 16px;overflow-x:auto;border-radius:10px;background:var(--hy-code-bg);color:#F3EEE6;font-size:12.5px;line-height:1.6}.hy-picker-code code{background:none!important;border:0!important;padding:0!important;color:inherit!important;white-space:pre}.hy-picker-copy{position:absolute;top:8px;right:8px;padding:3px 10px;border-radius:7px;cursor:pointer;font-size:12px;font-weight:500;color:#F3EEE6;background:#3A372F;border:1px solid #4A4742}.hy-picker-copy:hover{background:#45423A}.hy-picker-link{display:inline-flex;align-items:center;margin-top:2px;padding:6px 12px;border-radius:8px;background:var(--hy-sun);color:var(--hy-ink)!important;font-size:13px;font-weight:600;text-decoration:none!important;border:1px solid var(--hy-sun-deep)}.hy-picker-tabs{grid-template-columns:repeat(4, minmax(0, 1fr))}.hy-picker-tab:last-child:nth-child(4n+3){grid-column:span 2}.hy-picker-name{white-space:nowrap;overflow:hidden;text-overflow:ellipsis}@media (max-width: 640px){.hy-picker-tabs{grid-template-columns:repeat(2, minmax(0, 1fr))}.hy-picker-tab:last-child:nth-child(4n+3){grid-column:auto}}.hy-picker-name{white-space:normal;font-size:13.5px;line-height:1.25}.hy-picker-head{display:flex;justify-content:space-between;align-items:baseline;gap:16px;margin:24px 0 10px;font-size:14px;color:var(--hy-text-muted)}.hy-picker-head a{color:var(--hy-text)!important;font-weight:500;text-decoration:underline;text-decoration-color:var(--hy-sun-deep);text-decoration-thickness:2px;text-underline-offset:3px}.hy-picker-head+.hy-picker{margin-top:0}.hy-picker-tabs{grid-template-columns:repeat(4, minmax(0, 1fr))}.hy-picker-tab:last-child{border-right:0}.hy-client{margin:12px 0 20px}.hy-client-head{display:flex;align-items:center;gap:10px;padding:14px 20px;border-bottom:1px solid var(--hy-line);background:var(--hy-sun-wash);box-shadow:inset 0 2px 0 var(--hy-sun-deep)}html.dark .hy-client-head{background:rgba(255,208,55,0.10)}.hy-picker-code pre{padding-right:76px}#navbar a[href=\"https://github.com/heliyos-ai\"] .truncate,#navbar a[href*=\"linkedin.com/company/heliyos\"] .truncate{position:absolute;width:1px;height:1px;overflow:hidden;clip:rect(0 0 0 0);white-space:nowrap}#navbar a[href=\"https://github.com/heliyos-ai\"],#navbar a[href*=\"linkedin.com/company/heliyos\"]{padding:6px;border-radius:8px}#navbar a[href=\"https://github.com/heliyos-ai\"]:hover,#navbar a[href*=\"linkedin.com/company/heliyos\"]:hover{background:var(--hy-zone)}#navbar a[href=\"https://github.com/heliyos-ai\"] svg,#navbar a[href*=\"linkedin.com/company/heliyos\"] svg{width:18px;height:18px}#navbar ul:has(>li.navbar-link){gap:2px;align-items:center}#navbar ul:has(>li.navbar-link)>li{margin:0!important}#navbar ul:has(>li.navbar-link)>li:not(.navbar-link){order:-1;margin-right:12px!important}#navbar li.navbar-link>a{padding:6px!important}#navbar li.navbar-link>a svg{width:22px!important;height:22px!important}"}],"page":{"pagePath":"api-reference/interactions/get-an-interaction","slug":"/api-reference/interactions/get-an-interaction","pageMetadata":{"title":"Get an interaction","description":"Returns one email thread or meeting with every stored field: all messages and bodies for an\nemail, the transcript and analysis for a meeting, its labels, and the records it is linked to.","deprecated":null,"version":null,"sidebarTitle":"Get an interaction","openapi":"/api-reference/openapi.json get /v1/platform/interactions/{id}","href":"/api-reference/interactions/get-an-interaction","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns one email thread or meeting with every stored field: all messages and bodies for an\\nemail, the transcript and analysis for a meeting, its labels, and the records it is linked to.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsxs(Info,{children:[`In the Heliyos MCP server: `,_jsx(_components.a,{href:`/mcp/tools/timeline-and-activity#heliyos-interactions-get`,children:_jsx(_components.code,{children:`heliyos_interactions_get`})}),`.`]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Get an interaction","description":"Returns one email thread or meeting with every stored field: all messages and bodies for an\nemail, the transcript and analysis for a meeting, its labels, and the records it is linked to.","deprecated":null,"version":null,"sidebarTitle":"Get an interaction","openapi":"/api-reference/openapi.json get /v1/platform/interactions/{id}","href":"/api-reference/interactions/get-an-interaction","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getInteraction","tags":["Interactions"],"parameters":["d9adb991-ccbf-4f9d-81c7-fd76e930de27"],"responses":{"200":"6542b32b-acb7-4492-ac4d-cd4ec1c75b37","400":"34112142-6e43-42e3-94e3-5c128b434415","401":"e0133ef4-2166-4cbf-a3a2-c2903038c2b5","403":"c872db03-e065-4a9a-80d3-c363e828205b","404":"857772ac-77c9-4305-aeeb-ba09dc94e28c","429":"41a24b38-78d1-41b0-bad4-a8116392511f"},"summary":"Get an interaction","description":"Returns one email thread or meeting with every stored field: all messages and bodies for an\nemail, the transcript and analysis for a meeting, its labels, and the records it is linked to.","x-mint":{"href":"/api-reference/interactions/get-an-interaction","metadata":{},"content":"\u003cInfo>In the Heliyos MCP server: [`heliyos_interactions_get`](/mcp/tools/timeline-and-activity#heliyos-interactions-get).\u003c/Info>"},"method":"get","type":"path","servers":["cfb9dc49-4d79-4f5e-8469-9c9103787f1d"],"security":["24a65c4b-c280-4a52-a557-91d07005a21b"],"path":"/v1/platform/interactions/{id}","baseUrlOptions":["https://api-prod.heliyos.ai"],"title":"Get an interaction","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d9adb991-ccbf-4f9d-81c7-fd76e930de27":{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","isRequired":true,"description":"The interaction's id.","uniqueKey":"","typeLabel":"string"},"description":"The interaction's id.","example":"6728b1c2d3e4f5a6b7c8d9e0"}},"responses":{"6542b32b-acb7-4492-ac4d-cd4ec1c75b37":{"description":"The interaction.","content":{"application/json":{"schema":{"type":"object","required":["meta","data"],"properties":{"meta":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"A human-readable summary of the result.","isRequired":true,"uniqueKey":"meta.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"data":{"type":"object","description":"A synced email thread (`channel.type` `email`) or calendar meeting (`channel.type` `meeting`). Heliyos stores the provider's data and adds AI analysis. Fields depend on the channel and on how far the analysis has got; treat every field except `_id`, `organizationId` and `channel` as optional, and ignore fields you do not recognise.","additionalProperties":true,"properties":{"_id":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data._id","typeLabel":"string"},"organizationId":{"type":"string","description":"The workspace.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.organizationId","typeLabel":"string"},"channel":{"type":"object","properties":{"type":{"type":"string","enum":["email","meeting"],"description":"`email` for an email thread, `meeting` for a calendar event.","uniqueKey":"data.channel.type","typeLabel":"enum\u003cstring>"},"email":{"type":"string","description":"The connected mailbox or calendar the interaction was synced from.","uniqueKey":"data.channel.email","typeLabel":"string"}},"uniqueKey":"data.channel","typeLabel":"object"},"integrationId":{"type":"string","description":"The connected mailbox or calendar integration that synced it.","pattern":"^[0-9a-fA-F]{24}$","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.integrationId","typeLabel":"string"},"relationships":{"type":"array","description":"The records this interaction is linked to (matched from participants' addresses). Each entry carries `objectId`, `objectType` and `schemaId`, plus `object`: the linked record's `_id`, `objectType`, `baseSchemaId`, `isAgentAssigned` and all of its field values in `data`.","items":{"type":"object","additionalProperties":true,"properties":{"objectId":{"type":"string","pattern":"^[0-9a-fA-F]{24}$","description":"A 24-character hexadecimal id.","example":"66f1a8c3e4b0a1b2c3d4e5f6","uniqueKey":"data.relationships.items.[INDEX].objectId","typeLabel":"string"},"objectType":{"type":"string","description":"`company`, `people` or `deals`.","uniqueKey":"data.relationships.items.[INDEX].objectType","typeLabel":"string"},"schemaId":{"oneOf":[{"type":"string","description":"The linked record's object id.","uniqueKey":"data.relationships.items.[INDEX].schemaId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The linked record's object id.","uniqueKey":"data.relationships.items.[INDEX].schemaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.relationships.items.[INDEX].schemaId","typeLabel":"string | null"},"object":{"type":"object","additionalProperties":true,"description":"The linked record. Absent when the record no longer exists.","uniqueKey":"data.relationships.items.[INDEX].object","typeLabel":"object"}},"uniqueKey":"data.relationships.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.relationships","typeLabel":"object[]"},"categoryIds":{"type":"array","items":{"type":"string","uniqueKey":"data.categoryIds.items.[INDEX]","typeLabel":"string"},"description":"Ids of the labels applied to this interaction.","uniqueKey":"data.categoryIds","typeLabel":"string[]"},"classificationLabels":{"type":"array","description":"The labels in `categoryIds`, resolved (`_id`, `name`, `description`, `color`, `labels`).","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.classificationLabels.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.classificationLabels","typeLabel":"object[]"},"summary":{"type":"string","description":"The AI summary. Empty until the interaction is analysed.","uniqueKey":"data.summary","typeLabel":"string"},"sentiment":{"oneOf":[{"type":"string","description":"The other party's sentiment, written by the analysis. Usually `Positive`, `Negative`, `Neutral`, `Excited` or `Do Not Contact`. Null until analysed.","uniqueKey":"data.sentiment.oneOf.0","typeLabel":"string"},{"type":"null","description":"The other party's sentiment, written by the analysis. Usually `Positive`, `Negative`, `Neutral`, `Excited` or `Do Not Contact`. Null until analysed.","uniqueKey":"data.sentiment.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.sentiment","typeLabel":"string | null"},"sentimentReason":{"type":"string","description":"Why the analysis chose that sentiment.","uniqueKey":"data.sentimentReason","typeLabel":"string"},"isSummarized":{"type":"boolean","description":"Whether the AI analysis has run.","uniqueKey":"data.isSummarized","typeLabel":"boolean"},"createdAt":{"type":"string","description":"When Heliyos first synced it. Some older interactions store this as text.","format":"date-time","example":"2026-11-04T09:30:00.000Z","uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"lastMessageDate":{"type":"integer","description":"The newest message time (email) or the start time (meeting), in Unix seconds.","uniqueKey":"data.lastMessageDate","typeLabel":"integer"},"subject":{"type":"string","description":"Email: the thread subject.","uniqueKey":"data.subject","typeLabel":"string"},"thread_id":{"type":"string","description":"Email: the mail provider's thread id.","uniqueKey":"data.thread_id","typeLabel":"string"},"threads":{"type":"array","description":"Email: the messages in the thread, oldest first.","items":{"type":"object","description":"One message in an email thread.","additionalProperties":true,"properties":{"message_id":{"type":"string","description":"The mail provider's message id.","uniqueKey":"data.threads.items.[INDEX].message_id","typeLabel":"string"},"thread_id":{"type":"string","description":"The mail provider's thread id.","uniqueKey":"data.threads.items.[INDEX].thread_id","typeLabel":"string"},"subject":{"type":"string","description":"The message subject.","uniqueKey":"data.threads.items.[INDEX].subject","typeLabel":"string"},"snippet":{"type":"string","description":"A short plain-text preview.","uniqueKey":"data.threads.items.[INDEX].snippet","typeLabel":"string"},"body":{"type":"string","description":"The message body (HTML or text), when synced.","uniqueKey":"data.threads.items.[INDEX].body","typeLabel":"string"},"date":{"type":"integer","description":"When the message was sent, in Unix seconds.","uniqueKey":"data.threads.items.[INDEX].date","typeLabel":"integer"},"from":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"data.threads.items.[INDEX].from.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"data.threads.items.[INDEX].from.items.[INDEX].email","typeLabel":"string"}},"uniqueKey":"data.threads.items.[INDEX].from.items.[INDEX]","typeLabel":"object"},"description":"Sender.","uniqueKey":"data.threads.items.[INDEX].from","typeLabel":"object[]"},"to":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"data.threads.items.[INDEX].to.items.[INDEX].name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"data.threads.items.[INDEX].to.items.[INDEX].email","typeLabel":"string"}},"uniqueKey":"data.threads.items.[INDEX].to.items.[INDEX]","typeLabel":"object"},"description":"Recipients.","uniqueKey":"data.threads.items.[INDEX].to","typeLabel":"object[]"},"cc":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.threads.items.[INDEX].cc.items.[INDEX]","typeLabel":"object"},"description":"Copied recipients.","uniqueKey":"data.threads.items.[INDEX].cc","typeLabel":"object[]"},"unread":{"type":"boolean","description":"Whether the message is unread in the mailbox.","uniqueKey":"data.threads.items.[INDEX].unread","typeLabel":"boolean"},"starred":{"type":"boolean","description":"Whether the message is starred in the mailbox.","uniqueKey":"data.threads.items.[INDEX].starred","typeLabel":"boolean"},"attachments":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.threads.items.[INDEX].attachments.items.[INDEX]","typeLabel":"object"},"description":"Metadata for the files attached to the message.","uniqueKey":"data.threads.items.[INDEX].attachments","typeLabel":"object[]"},"agentGenerated":{"type":"boolean","description":"True when a worker wrote this message.","uniqueKey":"data.threads.items.[INDEX].agentGenerated","typeLabel":"boolean"},"isDraft":{"type":"boolean","description":"True for a worker's unsent draft.","uniqueKey":"data.threads.items.[INDEX].isDraft","typeLabel":"boolean"}},"uniqueKey":"data.threads.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.threads","typeLabel":"object[]"},"title":{"type":"string","description":"Meeting: the event title.","uniqueKey":"data.title","typeLabel":"string"},"when":{"type":"object","description":"Meeting: start and end, in Unix seconds, with time zones.","properties":{"start_time":{"type":"integer","uniqueKey":"data.when.start_time","typeLabel":"integer"},"end_time":{"type":"integer","uniqueKey":"data.when.end_time","typeLabel":"integer"},"start_timezone":{"type":"string","uniqueKey":"data.when.start_timezone","typeLabel":"string"},"end_timezone":{"type":"string","uniqueKey":"data.when.end_timezone","typeLabel":"string"}},"uniqueKey":"data.when","typeLabel":"object"},"participants":{"type":"array","description":"Meeting: invitees, each with `email` and `status`, the response as the calendar provider reports it (for example `yes`, `no` or `maybe`).","items":{"type":"object","additionalProperties":true,"properties":{"email":{"type":"string","uniqueKey":"data.participants.items.[INDEX].email","typeLabel":"string"},"status":{"type":"string","uniqueKey":"data.participants.items.[INDEX].status","typeLabel":"string"}},"uniqueKey":"data.participants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.participants","typeLabel":"object[]"},"creator":{"type":"object","description":"Meeting: who created the event (`name`, `email`).","additionalProperties":true,"uniqueKey":"data.creator","typeLabel":"object"},"conferencing":{"type":"object","description":"Meeting: the video provider and join details.","additionalProperties":true,"uniqueKey":"data.conferencing","typeLabel":"object"},"meetingStatus":{"type":"string","description":"Meeting: where recording and analysis stand. One of `NOT_STARTED`, `IN_PROGRESS`, `ANALYSING`, `COMPLETED`, `CANCELLED`, `RECORDING_NOT_PERMITTED`, `ABANDONED` or `ERROR`.","uniqueKey":"data.meetingStatus","typeLabel":"string"},"transcript":{"type":"array","description":"Meeting: the transcript, when the meeting was recorded.","items":{"type":"object","properties":{"timestamp":{"type":"string","uniqueKey":"data.transcript.items.[INDEX].timestamp","typeLabel":"string"},"speaker":{"type":"string","uniqueKey":"data.transcript.items.[INDEX].speaker","typeLabel":"string"},"dialogue":{"type":"string","uniqueKey":"data.transcript.items.[INDEX].dialogue","typeLabel":"string"}},"uniqueKey":"data.transcript.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.transcript","typeLabel":"object[]"},"takeaways":{"type":"string","description":"Meeting: takeaways from the analysis.","uniqueKey":"data.takeaways","typeLabel":"string"},"keyTakeaways":{"type":"string","description":"Meeting: key takeaways from the analysis.","uniqueKey":"data.keyTakeaways","typeLabel":"string"},"nextSteps":{"oneOf":[{"type":"string","description":"Meeting: next steps from the analysis, as text or a list.","uniqueKey":"data.nextSteps.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"data.nextSteps.oneOf.1.items.[INDEX]","typeLabel":"any"},"description":"Meeting: next steps from the analysis, as text or a list.","uniqueKey":"data.nextSteps.oneOf.1","typeLabel":"any[]"}],"uniqueKey":"data.nextSteps","typeLabel":"string | any[]"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"meta":{"message":"Interaction fetched successfully."},"data":{"_id":"6728b1c2d3e4f5a6b7c8d9e1","organizationId":"66a0f1e2d3c4b5a697887766","integrationId":"66a0f1e2d3c4b5a697885556","channel":{"type":"meeting","email":"priya@example.com"},"title":"Northwind Traders pricing review","when":{"start_time":1762329600,"end_time":1762331400,"start_timezone":"UTC","end_timezone":"UTC"},"participants":[{"email":"priya@example.com","status":"yes"},{"email":"ana.silva@northwind.example.com","status":"yes"}],"creator":{"name":"Priya Patel","email":"priya@example.com"},"meetingStatus":"COMPLETED","transcript":[{"timestamp":"00:01:12","speaker":"Ana Silva","dialogue":"We can commit to the Growth plan if the security review passes."}],"takeaways":"Budget confirmed for Q1. Security review is the last blocker.","nextSteps":"Send the security questionnaire answers by Friday.","relationships":[{"objectId":"66f1a8c3e4b0a1b2c3d4e5f6","objectType":"company","schemaId":"66a0f1e2d3c4b5a697880001","object":{"_id":"66f1a8c3e4b0a1b2c3d4e5f6","objectType":"company","baseSchemaId":"66a0f1e2d3c4b5a697880001","data":{"company_name":"Northwind Traders"}}}],"summary":"Pricing review with Northwind Traders. Budget is confirmed and the security review is the last step.","sentiment":"Positive","isSummarized":true,"createdAt":"2026-11-04T10:05:00.000Z"}},"examples":{"Example":{"title":"Example","value":{"meta":{"message":"Interaction fetched successfully."},"data":{"_id":"6728b1c2d3e4f5a6b7c8d9e1","organizationId":"66a0f1e2d3c4b5a697887766","integrationId":"66a0f1e2d3c4b5a697885556","channel":{"type":"meeting","email":"priya@example.com"},"title":"Northwind Traders pricing review","when":{"start_time":1762329600,"end_time":1762331400,"start_timezone":"UTC","end_timezone":"UTC"},"participants":[{"email":"priya@example.com","status":"yes"},{"email":"ana.silva@northwind.example.com","status":"yes"}],"creator":{"name":"Priya Patel","email":"priya@example.com"},"meetingStatus":"COMPLETED","transcript":[{"timestamp":"00:01:12","speaker":"Ana Silva","dialogue":"We can commit to the Growth plan if the security review passes."}],"takeaways":"Budget confirmed for Q1. Security review is the last blocker.","nextSteps":"Send the security questionnaire answers by Friday.","relationships":[{"objectId":"66f1a8c3e4b0a1b2c3d4e5f6","objectType":"company","schemaId":"66a0f1e2d3c4b5a697880001","object":{"_id":"66f1a8c3e4b0a1b2c3d4e5f6","objectType":"company","baseSchemaId":"66a0f1e2d3c4b5a697880001","data":{"company_name":"Northwind Traders"}}}],"summary":"Pricing review with Northwind Traders. Budget is confirmed and the security review is the last step.","sentiment":"Positive","isSummarized":true,"createdAt":"2026-11-04T10:05:00.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"34112142-6e43-42e3-94e3-5c128b434415":{"description":"Validation failed","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e0133ef4-2166-4cbf-a3a2-c2903038c2b5":{"description":"Unauthenticated","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c872db03-e065-4a9a-80d3-c363e828205b":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"857772ac-77c9-4305-aeeb-ba09dc94e28c":{"description":"NOT_FOUND: no interaction with this id in the workspace.","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"41a24b38-78d1-41b0-bad4-a8116392511f":{"description":"Rate limited","content":{"application/json":{"schema":{"type":"object","required":["message","error"],"properties":{"message":{"type":"string","description":"Same as error.message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","UNAUTHENTICATED","FORBIDDEN_ACTION","NOT_FOUND","RATE_LIMITED","CONFLICT","INTERNAL"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","error":{"code":"VALIDATION_FAILED","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"24a65c4b-c280-4a52-a557-91d07005a21b":{"bearerAuth":{"type":"http","scheme":"bearer","description":"A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"cfb9dc49-4d79-4f5e-8469-9c9103787f1d":{"url":"https://api-prod.heliyos.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"heliyos","siteName":"Heliyos","title":"Get an interaction - Heliyos","relatedPagesConfig":{"enabled":false,"limit":5,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"originalFileLocation":"api-reference/interactions/get-an-interaction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns one email thread or meeting with every stored field: all messages and bodies for an email, the transcript and analysis for a meeting, its labels, and the records it is linked to.\">\u003cmeta data-mint-head name=\"keywords\" content=\"Heliyos API, Heliyos MCP server, AI operating system for revenue, AI workers, customer memory, CRM API, MCP server for sales\">\u003cmeta data-mint-head name=\"application-name\" content=\"Heliyos\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_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/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get an interaction - Heliyos\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one email thread or meeting with every stored field: all messages and bodies for an email, the transcript and analysis for a meeting, its labels, and the records it is linked to.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Heliyos\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get an interaction - Heliyos\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one email thread or meeting with every stored field: all messages and bodies for an email, the transcript and analysis for a meeting, its labels, and the records it is linked to.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg\">\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/heliyos/VGWcHMG0dpBG1nWt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Heliyos\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#27251E\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Heliyos: The AI operating system for revenue\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Heliyos: The AI operating system for revenue\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/interactions/get-an-interaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.heliyos.ai/#organization\",\"name\":\"Heliyos\",\"url\":\"https://www.heliyos.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://www.heliyos.ai/assets/brand/logo-color.png\"},\"sameAs\":[\"https://www.heliyos.ai\",\"https://www.linkedin.com/company/heliyos\",\"https://github.com/heliyos-ai\",\"https://www.npmjs.com/package/@heliyos/mcp\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.heliyos.ai#website\",\"name\":\"Heliyos\",\"url\":\"https://docs.heliyos.ai\",\"publisher\":{\"@id\":\"https://www.heliyos.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction#webpage\",\"url\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction\",\"name\":\"Get an interaction\",\"description\":\"Returns one email thread or meeting with every stored field: all messages and bodies for an email, the transcript and analysis for a meeting, its labels, and the records it is linked to.\",\"isPartOf\":{\"@id\":\"https://docs.heliyos.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Interactions\",\"item\":\"https://docs.heliyos.ai/api-reference/interactions/list-interactions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get an interaction\",\"item\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction#apireference\",\"headline\":\"Get an interaction\",\"name\":\"Get an interaction\",\"description\":\"Returns one email thread or meeting with every stored field: all messages and bodies for an email, the transcript and analysis for a meeting, its labels, and the records it is linked to.\",\"url\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.heliyos.ai/api-reference/interactions/get-an-interaction#webpage\"},\"image\":\"https://www.heliyos.ai/assets/social-preview-2026-10-28.jpeg\",\"publisher\":{\"@id\":\"https://www.heliyos.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.heliyos.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Heliyos\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Heliyos","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tab-guides.svg","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tab-api.svg","groups":[{"group":"Overview","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-pages.svg","pages":[{"title":"API reference","href":"/api-reference/introduction"}]},{"group":"Workspace","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-general.svg","pages":[{"title":"Get the workspace","deprecated":null,"version":null,"sidebarTitle":"Get the workspace","openapi":"/api-reference/openapi.json get /v1/platform/organization","href":"/api-reference/workspace/get-the-workspace"},{"title":"List credit usage","deprecated":null,"version":null,"sidebarTitle":"List credit usage","openapi":"/api-reference/openapi.json get /v1/platform/usage","href":"/api-reference/workspace/list-credit-usage"}]},{"group":"Schemas","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-objects.svg","pages":[{"title":"List objects","deprecated":null,"version":null,"sidebarTitle":"List objects","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas","href":"/api-reference/schemas/list-objects"},{"title":"Get an object","deprecated":null,"version":null,"sidebarTitle":"Get an object","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas/{id}","href":"/api-reference/schemas/get-an-object"},{"title":"Create a field","deprecated":null,"version":null,"sidebarTitle":"Create a field","openapi":"/api-reference/openapi.json post /v1/platform/base-schemas/{id}/fields","href":"/api-reference/schemas/create-a-field"},{"title":"Update a field","deprecated":null,"version":null,"sidebarTitle":"Update a field","openapi":"/api-reference/openapi.json patch /v1/platform/base-schemas/{id}/fields/{fieldId}","href":"/api-reference/schemas/update-a-field"},{"title":"Delete a field","deprecated":null,"version":null,"sidebarTitle":"Delete a field","openapi":"/api-reference/openapi.json delete /v1/platform/base-schemas/{id}/fields/{fieldId}","href":"/api-reference/schemas/delete-a-field"}]},{"group":"Records","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-company.svg","pages":[{"title":"List records","deprecated":null,"version":null,"sidebarTitle":"List records","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas/{id}/records","href":"/api-reference/records/list-records"},{"title":"Get a record","deprecated":null,"version":null,"sidebarTitle":"Get a record","openapi":"/api-reference/openapi.json get /v1/platform/records/{id}","href":"/api-reference/records/get-a-record"},{"title":"Create a record","deprecated":null,"version":null,"sidebarTitle":"Create a record","openapi":"/api-reference/openapi.json post /v1/platform/base-schemas/{id}/records","href":"/api-reference/records/create-a-record"},{"title":"Update a record","deprecated":null,"version":null,"sidebarTitle":"Update a record","openapi":"/api-reference/openapi.json patch /v1/platform/records/{id}","href":"/api-reference/records/update-a-record"},{"title":"Delete records","deprecated":null,"version":null,"sidebarTitle":"Delete records","openapi":"/api-reference/openapi.json post /v1/platform/base-schemas/{id}/records/bulk-delete","href":"/api-reference/records/delete-records"},{"title":"List record names","deprecated":null,"version":null,"sidebarTitle":"List record names","openapi":"/api-reference/openapi.json get /v1/platform/base-schemas/{id}/records/lookup","href":"/api-reference/records/list-record-names"}]},{"group":"Timeline","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-history.svg","pages":[{"title":"List timeline entries","deprecated":null,"version":null,"sidebarTitle":"List timeline entries","openapi":"/api-reference/openapi.json get /v1/platform/records/{id}/timeline","href":"/api-reference/timeline/list-timeline-entries"}]},{"group":"Activities","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-runs.svg","pages":[{"title":"List record events","deprecated":null,"version":null,"sidebarTitle":"List record events","openapi":"/api-reference/openapi.json get /v1/platform/records/{id}/events","href":"/api-reference/activities/list-record-events"},{"title":"List task events","deprecated":null,"version":null,"sidebarTitle":"List task events","openapi":"/api-reference/openapi.json get /v1/platform/tasks/{id}/events","href":"/api-reference/activities/list-task-events"}]},{"group":"Interactions","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-inbox.svg","pages":[{"title":"List interactions","description":"Returns the workspace's synced email threads and meetings, from every connected mailbox and\ncalendar, with their AI analysis and the records they are linked to. Each row is the full\ninteraction, including message bodies and meeting transcripts, so keep `limit` small.\n\nBy default the list pages with a cursor, newest synced first: pass `limit`, then send\n`meta.pagination.next_cursor` back as `cursor`. A `sort`, or `page` (as a parameter or inside\n`filters`), switches to page-number paging, where `meta.pagination` holds `page`, `limit`,\n`totalPages`, `count` and `hasMore`. See [Pagination](/api-reference/pagination).\n\nTo list only the interactions linked to one record, send `{\"objectId\": \"\u003crecord id>\"}` in `filters`.","deprecated":null,"version":null,"sidebarTitle":"List interactions","openapi":"/api-reference/openapi.json get /v1/platform/interactions","href":"/api-reference/interactions/list-interactions"},{"title":"Get an interaction","deprecated":null,"version":null,"sidebarTitle":"Get an interaction","openapi":"/api-reference/openapi.json get /v1/platform/interactions/{id}","href":"/api-reference/interactions/get-an-interaction"}]},{"group":"Notes","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-notes.svg","pages":[{"title":"List notes","description":"Returns the workspace's notes, newest first.\n\nBy default the list pages with a cursor: pass `limit`, then send `meta.pagination.next_cursor`\nback as `cursor` for the next page. To filter, search or sort, send a JSON `filters` object.\nA custom sort or `page` switches to page-number paging. See [Pagination](/api-reference/pagination)\nand [Filtering and sorting](/api-reference/filtering).\n\nTo list only the notes linked to one record, send `{\"relatedObjectId\": \"\u003crecord id>\"}` in `filters`.","deprecated":null,"version":null,"sidebarTitle":"List notes","openapi":"/api-reference/openapi.json get /v1/platform/notes","href":"/api-reference/notes/list-notes"},{"title":"Get a note","deprecated":null,"version":null,"sidebarTitle":"Get a note","openapi":"/api-reference/openapi.json get /v1/platform/notes/{id}","href":"/api-reference/notes/get-a-note"},{"title":"Create a note","deprecated":null,"version":null,"sidebarTitle":"Create a note","openapi":"/api-reference/openapi.json post /v1/platform/notes","href":"/api-reference/notes/create-a-note"},{"title":"Update a note","deprecated":null,"version":null,"sidebarTitle":"Update a note","openapi":"/api-reference/openapi.json patch /v1/platform/notes/{id}","href":"/api-reference/notes/update-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"sidebarTitle":"Delete a note","openapi":"/api-reference/openapi.json delete /v1/platform/notes/{id}","href":"/api-reference/notes/delete-a-note"}]},{"group":"Tasks","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-tasks.svg","pages":[{"title":"List tasks","deprecated":null,"version":null,"sidebarTitle":"List tasks","openapi":"/api-reference/openapi.json get /v1/platform/tasks","href":"/api-reference/tasks/list-tasks"},{"title":"Get a task","deprecated":null,"version":null,"sidebarTitle":"Get a task","openapi":"/api-reference/openapi.json get /v1/platform/tasks/{id}","href":"/api-reference/tasks/get-a-task"},{"title":"Create a task","deprecated":null,"version":null,"sidebarTitle":"Create a task","openapi":"/api-reference/openapi.json post /v1/platform/tasks","href":"/api-reference/tasks/create-a-task"},{"title":"Update a task","deprecated":null,"version":null,"sidebarTitle":"Update a task","openapi":"/api-reference/openapi.json patch /v1/platform/tasks/{id}","href":"/api-reference/tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"sidebarTitle":"Delete a task","openapi":"/api-reference/openapi.json delete /v1/platform/tasks/{id}","href":"/api-reference/tasks/delete-a-task"},{"title":"Run workers on a task","deprecated":null,"version":null,"sidebarTitle":"Run workers on a task","openapi":"/api-reference/openapi.json post /v1/platform/tasks/{id}/runs","href":"/api-reference/tasks/run-workers-on-a-task"}]},{"group":"Workers and runs","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-workers.svg","pages":[{"title":"List workers","deprecated":null,"version":null,"sidebarTitle":"List workers","openapi":"/api-reference/openapi.json get /v1/platform/agents","href":"/api-reference/workers-and-runs/list-workers"},{"title":"Get a worker","deprecated":null,"version":null,"sidebarTitle":"Get a worker","openapi":"/api-reference/openapi.json get /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/get-a-worker"},{"title":"Create a worker","deprecated":null,"version":null,"sidebarTitle":"Create a worker","openapi":"/api-reference/openapi.json post /v1/platform/agents","href":"/api-reference/workers-and-runs/create-a-worker"},{"title":"Update a worker","deprecated":null,"version":null,"sidebarTitle":"Update a worker","openapi":"/api-reference/openapi.json patch /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/update-a-worker"},{"title":"Delete a worker","deprecated":null,"version":null,"sidebarTitle":"Delete a worker","openapi":"/api-reference/openapi.json delete /v1/platform/agents/{id}","href":"/api-reference/workers-and-runs/delete-a-worker"},{"title":"Ask Heliyos","deprecated":null,"version":null,"sidebarTitle":"Ask Heliyos","openapi":"/api-reference/openapi.json post /v1/platform/orchestrator/chats","href":"/api-reference/workers-and-runs/ask-heliyos"},{"title":"List runs","deprecated":null,"version":null,"sidebarTitle":"List runs","openapi":"/api-reference/openapi.json get /v1/platform/workers/runs","href":"/api-reference/workers-and-runs/list-runs"},{"title":"Get a run","deprecated":null,"version":null,"sidebarTitle":"Get a run","openapi":"/api-reference/openapi.json get /v1/platform/workers/runs/{id}","href":"/api-reference/workers-and-runs/get-a-run"},{"title":"List triggers","deprecated":null,"version":null,"sidebarTitle":"List triggers","openapi":"/api-reference/openapi.json get /v1/platform/workers/triggers","href":"/api-reference/workers-and-runs/list-triggers"},{"title":"List actions","deprecated":null,"version":null,"sidebarTitle":"List actions","openapi":"/api-reference/openapi.json get /v1/platform/workers/tools","href":"/api-reference/workers-and-runs/list-actions"}]},{"group":"Reviews","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tasks.svg","pages":[{"title":"List reviews","deprecated":null,"version":null,"sidebarTitle":"List reviews","openapi":"/api-reference/openapi.json get /v1/platform/reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Get a review","deprecated":null,"version":null,"sidebarTitle":"Get a review","openapi":"/api-reference/openapi.json get /v1/platform/reviews/{id}","href":"/api-reference/reviews/get-a-review"},{"title":"Approve or reject a review","deprecated":null,"version":null,"sidebarTitle":"Approve or reject a review","openapi":"/api-reference/openapi.json post /v1/platform/reviews/{id}/decisions","href":"/api-reference/reviews/approve-or-reject-a-review"}]},{"group":"Scouts","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-scouts.svg","pages":[{"title":"List workspace Scouts","deprecated":null,"version":null,"sidebarTitle":"List workspace scouts","openapi":"/api-reference/openapi.json get /v1/platform/global-scouts","href":"/api-reference/scouts/list-workspace-scouts"},{"title":"Get a workspace Scout","deprecated":null,"version":null,"sidebarTitle":"Get a workspace scout","openapi":"/api-reference/openapi.json get /v1/platform/global-scouts/{id}","href":"/api-reference/scouts/get-a-workspace-scout"},{"title":"Create a custom Scout","deprecated":null,"version":null,"sidebarTitle":"Create a custom scout","openapi":"/api-reference/openapi.json post /v1/platform/global-scouts","href":"/api-reference/scouts/create-a-custom-scout"},{"title":"Update a custom Scout","deprecated":null,"version":null,"sidebarTitle":"Update a custom scout","openapi":"/api-reference/openapi.json patch /v1/platform/global-scouts/{id}","href":"/api-reference/scouts/update-a-custom-scout"},{"title":"Set a workspace Scout state","deprecated":null,"version":null,"sidebarTitle":"Set a workspace scout state","openapi":"/api-reference/openapi.json post /v1/platform/global-scouts/{id}/state","href":"/api-reference/scouts/set-a-workspace-scout-state"},{"title":"Delete a custom Scout","deprecated":null,"version":null,"sidebarTitle":"Delete a custom scout","openapi":"/api-reference/openapi.json delete /v1/platform/global-scouts/{id}","href":"/api-reference/scouts/delete-a-custom-scout"},{"title":"List company Scouts","deprecated":null,"version":null,"sidebarTitle":"List company scouts","openapi":"/api-reference/openapi.json get /v1/platform/companies/{id}/scouts","href":"/api-reference/scouts/list-company-scouts"},{"title":"Add Scouts to a company","deprecated":null,"version":null,"sidebarTitle":"Add scouts to a company","openapi":"/api-reference/openapi.json post /v1/platform/companies/{id}/scouts","href":"/api-reference/scouts/add-scouts-to-a-company"},{"title":"Remove company Scouts","deprecated":null,"version":null,"sidebarTitle":"Remove company scouts","openapi":"/api-reference/openapi.json delete /v1/platform/companies/{id}/scouts","href":"/api-reference/scouts/remove-company-scouts"}]},{"group":"Signals","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-signals.svg","pages":[{"title":"List signals","deprecated":null,"version":null,"sidebarTitle":"List signals","openapi":"/api-reference/openapi.json get /v1/platform/signals","href":"/api-reference/signals/list-signals"},{"title":"List workspace Scout signals","deprecated":null,"version":null,"sidebarTitle":"List workspace scout signals","openapi":"/api-reference/openapi.json get /v1/platform/global-scouts/{id}/signals","href":"/api-reference/signals/list-workspace-scout-signals"},{"title":"Mark a signal read","deprecated":null,"version":null,"sidebarTitle":"Mark a signal read","openapi":"/api-reference/openapi.json post /v1/platform/signals/{id}/read","href":"/api-reference/signals/mark-a-signal-read"},{"title":"Mark signals read in bulk","deprecated":null,"version":null,"sidebarTitle":"Mark signals read in bulk","openapi":"/api-reference/openapi.json post /v1/platform/signals/bulk-read","href":"/api-reference/signals/mark-signals-read-in-bulk"}]},{"group":"Watchlist","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-watchlist.svg","pages":[{"title":"Get watchlist statistics","deprecated":null,"version":null,"sidebarTitle":"Get watchlist statistics","openapi":"/api-reference/openapi.json get /v1/platform/watchlist/statistics","href":"/api-reference/watchlist/get-watchlist-statistics"},{"title":"Watch a company","deprecated":null,"version":null,"sidebarTitle":"Watch a company","openapi":"/api-reference/openapi.json post /v1/platform/companies/{id}/watch","href":"/api-reference/watchlist/watch-a-company"},{"title":"Unwatch a company","deprecated":null,"version":null,"sidebarTitle":"Unwatch a company","openapi":"/api-reference/openapi.json delete /v1/platform/companies/{id}/watch","href":"/api-reference/watchlist/unwatch-a-company"}]},{"group":"Knowledge base","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-knowledge.svg","pages":[{"title":"Get the knowledge base","deprecated":null,"version":null,"sidebarTitle":"Get the knowledge base","openapi":"/api-reference/openapi.json get /v1/auth/organizations/current","href":"/api-reference/knowledge-base/get-the-knowledge-base"},{"title":"Update the knowledge base","deprecated":null,"version":null,"sidebarTitle":"Update the knowledge base","openapi":"/api-reference/openapi.json patch /v1/auth/organizations/current","href":"/api-reference/knowledge-base/update-the-knowledge-base"}]},{"group":"Files","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-file.svg","pages":[{"title":"Create an upload URL","deprecated":null,"version":null,"sidebarTitle":"Create an upload url","openapi":"/api-reference/openapi.json post /v1/platform/attachments/presigned-urls","href":"/api-reference/files/create-an-upload-url"},{"title":"Create a file","deprecated":null,"version":null,"sidebarTitle":"Create a file","openapi":"/api-reference/openapi.json post /v1/platform/attachments","href":"/api-reference/files/create-a-file"},{"title":"List files","deprecated":null,"version":null,"sidebarTitle":"List files","openapi":"/api-reference/openapi.json get /v1/platform/attachments","href":"/api-reference/files/list-files"},{"title":"Get a file","deprecated":null,"version":null,"sidebarTitle":"Get a file","openapi":"/api-reference/openapi.json get /v1/platform/attachments/{id}","href":"/api-reference/files/get-a-file"},{"title":"Get a file download link","deprecated":null,"version":null,"sidebarTitle":"Get a file download link","openapi":"/api-reference/openapi.json get /v1/platform/attachments/{id}/download","href":"/api-reference/files/get-a-file-download-link"},{"title":"Delete a file","deprecated":null,"version":null,"sidebarTitle":"Delete a file","openapi":"/api-reference/openapi.json delete /v1/platform/attachments/{id}","href":"/api-reference/files/delete-a-file"}]},{"group":"Labels","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-labels.svg","pages":[{"title":"List label groups","deprecated":null,"version":null,"sidebarTitle":"List label groups","openapi":"/api-reference/openapi.json get /v1/platform/classification-labels","href":"/api-reference/labels/list-label-groups"},{"title":"Create a label group","deprecated":null,"version":null,"sidebarTitle":"Create a label group","openapi":"/api-reference/openapi.json post /v1/platform/classification-labels","href":"/api-reference/labels/create-a-label-group"},{"title":"Update a label group","deprecated":null,"version":null,"sidebarTitle":"Update a label group","openapi":"/api-reference/openapi.json patch /v1/platform/classification-labels/{id}","href":"/api-reference/labels/update-a-label-group"},{"title":"Delete a label group","deprecated":null,"version":null,"sidebarTitle":"Delete a label group","openapi":"/api-reference/openapi.json delete /v1/platform/classification-labels/{id}","href":"/api-reference/labels/delete-a-label-group"}]},{"group":"Team","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-teams.svg","pages":[{"title":"List team members","deprecated":null,"version":null,"sidebarTitle":"List team members","openapi":"/api-reference/openapi.json get /v1/auth/team-memberships","href":"/api-reference/team/list-team-members"},{"title":"Invite a team member","deprecated":null,"version":null,"sidebarTitle":"Invite a team member","openapi":"/api-reference/openapi.json post /v1/auth/team-memberships","href":"/api-reference/team/invite-a-team-member"},{"title":"Remove a team member","deprecated":null,"version":null,"sidebarTitle":"Remove a team member","openapi":"/api-reference/openapi.json delete /v1/auth/team-memberships/{id}","href":"/api-reference/team/remove-a-team-member"},{"title":"Change a team member role","deprecated":null,"version":null,"sidebarTitle":"Change a team member role","openapi":"/api-reference/openapi.json patch /v1/auth/team-memberships/{id}/role","href":"/api-reference/team/change-a-team-member-role"},{"title":"List roles","deprecated":null,"version":null,"sidebarTitle":"List roles","openapi":"/api-reference/openapi.json get /v1/auth/roles","href":"/api-reference/team/list-roles"}]},{"group":"Notification settings","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-preferences.svg","pages":[{"title":"Get notification settings","deprecated":null,"version":null,"sidebarTitle":"Get notification settings","openapi":"/api-reference/openapi.json get /v1/platform/notification-settings","href":"/api-reference/notification-settings/get-notification-settings"},{"title":"Update notification settings","deprecated":null,"version":null,"sidebarTitle":"Update notification settings","openapi":"/api-reference/openapi.json patch /v1/platform/notification-settings","href":"/api-reference/notification-settings/update-notification-settings"}]}]},{"tab":"MCP server","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/tab-mcp.svg","pages":[{"title":"MCP server","href":"/mcp/overview"}]},{"tab":"Changelog","icon":"https://mintlify.s3.us-west-1.amazonaws.com/heliyos/icons/app-history.svg","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get an interaction - Heliyos","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}