Search notes by keyword. The scope of the search is controlled by the request body:
Provide noteIds to limit the search to specific notes.
Provide companyId to limit the search to notes associated with a specific company.
Omit both to search across your entire account.
noteIds and companyId are mutually exclusive.
Returns up to limit notes ordered by relevance. Prompts with no strong matches may
still return low-relevance results.
Each result contains a matched note and a single representative excerpt (a matching
passage from that note). Even if a note contains multiple matching passages, it appears
exactly once in the response with one excerpt.
Matching note results, one per note, ordered by relevance.
Maximum array length: 100
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Affinity Developer Documentation","colors":{"primary":"#3B0D3A","light":"#FEFBF6","dark":"#3B0D3A"},"logo":{"light":"https://mintcdn.com/affinityco/eam7hibfKwa27ik4/logo/light.svg?fit=max\u0026auto=format\u0026n=eam7hibfKwa27ik4\u0026q=85\u0026s=3903d98e7859d09064804785a73f9056","dark":"https://mintcdn.com/affinityco/eam7hibfKwa27ik4/logo/dark.svg?fit=max\u0026auto=format\u0026n=eam7hibfKwa27ik4\u0026q=85\u0026s=f0a77906ec371191932c9fc539107445"},"favicon":{"light":"https://mintcdn.com/affinityco/at5q0mqgqCpLezS3/favicon/light.png?fit=max\u0026auto=format\u0026n=at5q0mqgqCpLezS3\u0026q=85\u0026s=baab4f4ec5890f8e12dd6e2402eb7a45","dark":"https://mintcdn.com/affinityco/at5q0mqgqCpLezS3/favicon/dark.png?fit=max\u0026auto=format\u0026n=at5q0mqgqCpLezS3\u0026q=85\u0026s=b97e0a7a9720956e79587bfd7c29153d"},"background":{"decoration":"gradient","color":{"light":"#FEFBF6","dark":"#1E0E1D"}},"navbar":{"links":[{"href":"https://api-docs.affinity.co/","label":"API V1"},{"href":"https://status.affinity.co/","label":"Status"},{"href":"https://www.affinity.co/product-release/latest-releases","label":"Releases"},{"href":"https://www.affinity.co/lp/api-newsletter","label":"Newsletter"}]},"footer":{"socials":{"x":"https://x.com/affinity__crm","linkedin":"https://www.linkedin.com/company/project-affinity","youtube":"https://www.youtube.com/channel/UCvnEfi1Li0VHGXKjLV6O9Pw","facebook":"https://www.facebook.com/AffinityHQ"}},"seo":{"metatags":{"og:image":"/images/opengraph-affinity.png","twitter:image":"/images/opengraph-affinity.png","twitter:card":"summary_large_image"}},"fonts":{"heading":{"family":"Arizona Mix","weight":500,"source":"fonts/ABCArizonaMix-Medium.woff2","format":"woff2"},"body":{"family":"Booton","weight":400,"source":"fonts/Booton-Regular.woff2","format":"woff2"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"interaction":{"drilldown":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"affinityco","hasAudioNarration":false,"actualSubdomain":"affinityco","customDomains":["developer.affinity.co"],"gitSource":{"type":"github","owner":"affinity","repo":"affinity-mintlify","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae4d7706d11d33003dd1bd2","collectionId":"501b48d4-f5bf-4154-8113-29be1052dfac","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae4d7706d11d33003dd1bd2"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4d7706d11d33003dd1bd2","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API Reference","count":302},{"language":"default","tag":"2026-09-17","count":115},{"language":"default","tag":"2026-07-15","count":100},{"language":"default","tag":"Records","count":91},{"language":"default","tag":"2024-01-01","count":87},{"language":"default","tag":"Lists","count":52},{"language":"default","tag":"Persons","count":49},{"language":"default","tag":"Data Share","count":46},{"language":"default","tag":"Companies","count":45},{"language":"default","tag":"V1_0","count":37}]},"assistantConfig":{},"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":"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":"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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"css/custom.css","content":".dark{--primary-light:254 251 246}.dark img[src=\"/images/chatgpt.svg\"],.dark img[src=\"/images/claude.svg\"],.dark img[src=\"/images/gemini.svg\"],.dark img[src=\"/images/github.svg\"]{filter:invert(1)}.sidebar-group a,.sidebar-group-header{font-size:.8125rem!important}.sidebar-group>li>a{padding-top:.1875rem!important;padding-bottom:.1875rem!important;column-gap:.5rem!important}div:has(>.sidebar-group-header){margin-top:1.25rem!important}.sidebar-group-header{margin-bottom:.375rem!important}.sidebar-group-header h5{font-family:'Booton',sans-serif!important;font-weight:400!important;font-size:.6875rem!important;letter-spacing:.06em;text-transform:uppercase}#sidebar-toggle-all{position:absolute;right:2rem;bottom:0;left:0;z-index:20;display:flex;gap:.75rem;padding:.625rem 1rem;font-size:.75rem;border-top:1px solid rgb(0 0 0/.08);background:var(--brand-alabaster)}.dark #sidebar-toggle-all{border-top-color:rgb(255 255 255/.08);background:var(--brand-jaguar)}#sidebar-toggle-all button{color:rgb(107 114 128);cursor:pointer}#sidebar-toggle-all button:hover{color:rgb(17 24 39);text-decoration:underline}.dark #sidebar-toggle-all button{color:rgb(156 163 175)}.dark #sidebar-toggle-all button:hover{color:rgb(229 231 235)}#content-area li,#content-area p{font-size:.9375rem!important}#content-area td,#content-area th{font-size:.8125rem!important;line-height:1.45!important}#content-area td:first-child,#content-area th:first-child{white-space:nowrap!important}#content-area td:nth-child(2),#content-area th:nth-child(2){min-width:6rem!important}@font-face{font-family:\"Arizona Mix\";font-style:normal;font-weight:400;font-display:swap;src:url(/fonts/ABCArizonaMix-Regular.woff2) format(\"woff2\")}@font-face{font-family:\"Arizona Mix\";font-style:normal;font-weight:500;font-display:swap;src:url(/fonts/ABCArizonaMix-Medium.woff2) format(\"woff2\")}@font-face{font-family:\"Booton\";font-style:normal;font-weight:400;font-display:swap;src:url(/fonts/Booton-Regular.woff2) format(\"woff2\")}@font-face{font-family:\"Booton\";font-style:italic;font-weight:400;font-display:swap;src:url(/fonts/Booton-RegularItalic.woff2) format(\"woff2\")}@font-face{font-family:\"Booton\";font-style:normal;font-weight:500;font-display:swap;src:url(/fonts/Booton-Medium.woff2) format(\"woff2\")}@font-face{font-family:\"Booton\";font-style:normal;font-weight:600;font-display:swap;src:url(/fonts/Booton-SemiBold.woff2) format(\"woff2\")}@font-face{font-family:\"Booton\";font-style:italic;font-weight:600;font-display:swap;src:url(/fonts/Booton-SemiBoldItalic.woff2) format(\"woff2\")}:root{--brand-plum:#3B0D3A;--brand-alabaster:#FEFBF6;--brand-jaguar:#1E0E1D;--brand-grasshopper:#CDEC3E;--brand-cream:#FFEAAB;--brand-lavender:#7A23D1}.prose a{color:var(--brand-lavender)}.dark .prose a{color:var(--brand-cream)}"}],"page":{"pagePath":"api-reference/2024-01-01/notes/search-notes-by-keyword","slug":"/api-reference/2024-01-01/notes/search-notes-by-keyword","pageMetadata":{"title":"Search Notes by Keyword","description":"Search notes by keyword. The scope of the search is controlled by the request body:\n\n- Provide `noteIds` to limit the search to specific notes.\n- Provide `companyId` to limit the search to notes associated with a specific company.\n- Omit both to search across your entire account.\n\n`noteIds` and `companyId` are mutually exclusive.\n\nReturns up to `limit` notes ordered by relevance. Prompts with no strong matches may\nstill return low-relevance results.\n\nEach result contains a matched note and a single representative excerpt (a matching\npassage from that note). Even if a note contains multiple matching passages, it appears\nexactly once in the response with one excerpt.\n","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/notes/search","href":"/api-reference/2024-01-01/notes/search-notes-by-keyword","autogeneratedByOpenApi":true},"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: \"Search notes by keyword. The scope of the search is controlled by the request body:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Provide \", _jsx(_components.code, {\n children: \"noteIds\"\n }), \" to limit the search to specific notes.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Provide \", _jsx(_components.code, {\n children: \"companyId\"\n }), \" to limit the search to notes associated with a specific company.\"]\n }), \"\\n\", _jsx(_components.li, {\n children: \"Omit both to search across your entire account.\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"noteIds\"\n }), \" and \", _jsx(_components.code, {\n children: \"companyId\"\n }), \" are mutually exclusive.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Returns up to \", _jsx(_components.code, {\n children: \"limit\"\n }), \" notes ordered by relevance. Prompts with no strong matches may\\nstill return low-relevance results.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each result contains a matched note and a single representative excerpt (a matching\\npassage from that note). Even if a note contains multiple matching passages, it appears\\nexactly once in the response with one excerpt.\"\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":"Search Notes by Keyword","description":"Search notes by keyword. The scope of the search is controlled by the request body:\n\n- Provide `noteIds` to limit the search to specific notes.\n- Provide `companyId` to limit the search to notes associated with a specific company.\n- Omit both to search across your entire account.\n\n`noteIds` and `companyId` are mutually exclusive.\n\nReturns up to `limit` notes ordered by relevance. Prompts with no strong matches may\nstill return low-relevance results.\n\nEach result contains a matched note and a single representative excerpt (a matching\npassage from that note). Even if a note contains multiple matching passages, it appears\nexactly once in the response with one excerpt.\n","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/notes/search","href":"/api-reference/2024-01-01/notes/search-notes-by-keyword","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/affinityco/8a6c3f4313845c2a/amplitude.js","/_mintlify/custom/affinityco/22bc746bddd390fd/sidebar-toggle.js"],"openApiReferenceData":{"operation":{"x-operation-type":"retrieval-multiple-search","description":"Search notes by keyword. The scope of the search is controlled by the request body:\n\n- Provide `noteIds` to limit the search to specific notes.\n- Provide `companyId` to limit the search to notes associated with a specific company.\n- Omit both to search across your entire account.\n\n`noteIds` and `companyId` are mutually exclusive.\n\nReturns up to `limit` notes ordered by relevance. Prompts with no strong matches may\nstill return low-relevance results.\n\nEach result contains a matched note and a single representative excerpt (a matching\npassage from that note). Even if a note contains multiple matching passages, it appears\nexactly once in the response with one excerpt.\n","summary":"Search Notes by Keyword","operationId":"v2_notes_search__POST","security":["8a63f0b7-521f-4316-b4fb-e564dd0c357f","e77058d1-29b4-4c2d-a479-93f5eb8b924d"],"tags":["Notes"],"requestBody":"ba1ba2ca-d101-45aa-a4c2-bac3c67a1f72","responses":{"201":"b6981ff9-1e46-446c-9161-5b5aa9ffd151","400":"005d6843-e307-4405-8a49-b0d8c5c4bb65","404":"e5884458-8461-4e98-be42-e8e8ba420de1","default":"c2a8623e-e796-42f4-b2c5-cb07f52de18c"},"method":"post","type":"path","servers":["e30dbe19-8523-4582-a403-60761bd25e12"],"path":"/v2/notes/search","baseUrlOptions":["https://api.affinity.co"],"title":"Search Notes by Keyword","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Note Keyword Search Criteria (org-wide or by note IDs)","description":"Search all notes in the org, or limit to specific note IDs.","required":["prompt"],"properties":{"prompt":{"description":"The search query. Returns up to `limit` notes ordered by relevance. Prompts with\nno strong matches may still return low-relevance results.\n","type":"string","minLength":3,"maxLength":500,"example":"Series B terms","examples":["Series B terms"],"isRequired":true,"uniqueKey":"oneOf.0.prompt","typeLabel":"string"},"noteIds":{"description":"Limit search to these specific notes. Omit for org-wide search.","type":"array","items":{"type":"integer","format":"int32","minimum":1,"maximum":2147483647,"uniqueKey":"oneOf.0.noteIds.items.[INDEX]","typeLabel":"integer\u003cint32>"},"maxItems":100,"examples":[[1,2]],"uniqueKey":"oneOf.0.noteIds","typeLabel":"integer\u003cint32>[]"},"limit":{"description":"Maximum number of notes to return.","type":"integer","format":"int32","minimum":1,"maximum":100,"default":20,"example":20,"uniqueKey":"oneOf.0.limit","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"Note Keyword Search Criteria (org-wide or by note IDs) · object"},{"type":"object","title":"Note Keyword Search Criteria (by company)","description":"Search notes associated with a specific company.","required":["prompt"],"properties":{"prompt":{"description":"The search query. Returns up to `limit` notes ordered by relevance. Prompts with\nno strong matches may still return low-relevance results.\n","type":"string","minLength":3,"maxLength":500,"example":"Series B terms","examples":["Series B terms"],"isRequired":true,"uniqueKey":"oneOf.1.prompt","typeLabel":"string"},"companyId":{"description":"Restrict search to notes associated with this company.","type":"integer","format":"int64","minimum":1,"maximum":9007199254740991,"example":1,"uniqueKey":"oneOf.1.companyId","typeLabel":"integer\u003cint64>"},"limit":{"description":"Maximum number of notes to return.","type":"integer","format":"int32","minimum":1,"maximum":100,"default":20,"example":20,"uniqueKey":"oneOf.1.limit","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"Note Keyword Search Criteria (by company) · object"}],"uniqueKey":"","typeLabel":"Note Keyword Search Criteria (org-wide or by note IDs) · object | Note Keyword Search Criteria (by company) · object"},"examples":{"Example":{"title":"Example","value":{"prompt":"Series B terms","noteIds":[1,2],"limit":20}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b6981ff9-1e46-446c-9161-5b5aa9ffd151":{"description":"Created","content":{"application/json":{"schema":{"title":"notes.KeywordSearchResult","description":"Results of a keyword search over notes.","type":"object","properties":{"data":{"description":"Matching note results, one per note, ordered by relevance.","type":"array","maxItems":100,"items":{"title":"notes.SearchResult","description":"A matched note and a matching passage. Each note appears at most once per response, regardless of how many passages matched.","type":"object","properties":{"note":{"description":"The matched note.","type":"object","properties":{"id":{"description":"The note's unique identifier.","type":"integer","format":"int32","minimum":1,"maximum":2147483647,"examples":[1],"isRequired":true,"uniqueKey":"data.items.[INDEX].note.id","typeLabel":"integer\u003cint32>"},"kind":{"description":"The type of note.\n- `note`: user-written note\n- `meeting-note`: note attached to a meeting\n- `email-note`: note from an email thread\n- `ai-summary`: auto-generated note summary\n- `meeting-ai-summary`: auto-generated meeting summary\n- `chat-message-note`: note attached to a chat message\n","type":"string","enum":["note","meeting-note","email-note","ai-summary","meeting-ai-summary","chat-message-note"],"examples":["note"],"isRequired":true,"uniqueKey":"data.items.[INDEX].note.kind","typeLabel":"enum\u003cstring>"}},"required":["id","kind"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].note","typeLabel":"object"},"preview":{"description":"The matching passage, up to 2,000 characters.","type":"string","maxLength":2000,"example":"We discussed the Series B terms with the founding team last Thursday.","examples":["We discussed the Series B terms with the founding team last Thursday."],"isRequired":true,"uniqueKey":"data.items.[INDEX].preview","typeLabel":"string"}},"required":["note","preview"],"additionalProperties":false,"uniqueKey":"data.items.[INDEX]","typeLabel":"notes.SearchResult · object"},"isRequired":true,"uniqueKey":"data","typeLabel":"notes.SearchResult · object[]"}},"required":["data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"notes.KeywordSearchResult · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"note":{"id":1,"kind":"note"},"preview":"We discussed the Series B terms with the founding team last Thursday."}]}}},"exampleType":"generated"}},"headers":{"x-ratelimit-limit-user":{"description":"Number of requests allowed per minute for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-remaining":{"description":"Number of requests remaining for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-reset":{"description":"Time in seconds before the limit resets for the user","schema":{"type":"integer"}},"x-ratelimit-limit-org":{"description":"Number of requests allowed per month for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-remaining":{"description":"Number of requests remaining for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-reset":{"description":"Time in seconds before the limit resets for the account","schema":{"type":"integer"}}},"exampleType":"generated"},"005d6843-e307-4405-8a49-b0d8c5c4bb65":{"description":"Bad Request","content":{"application/json":{"schema":{"title":"responses.400","type":"object","properties":{"errors":{"type":"array","items":{"oneOf":[{"type":"object","title":"BadRequestError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"bad-request","example":"bad-request","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"BadRequestError · object"},{"type":"object","title":"ValidationError","required":["code","message","param"],"properties":{"code":{"description":"Error code","type":"string","const":"validation","example":"validation","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.message","typeLabel":"string"},"param":{"description":"Param the error refers to","type":"string","example":"limit","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.param","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"ValidationError · object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"BadRequestError · object | ValidationError · object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"(BadRequestError · object | ValidationError · object)[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"responses.400 · object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"bad-request","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"headers":{"x-ratelimit-limit-user":{"description":"Number of requests allowed per minute for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-remaining":{"description":"Number of requests remaining for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-reset":{"description":"Time in seconds before the limit resets for the user","schema":{"type":"integer"}},"x-ratelimit-limit-org":{"description":"Number of requests allowed per month for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-remaining":{"description":"Number of requests remaining for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-reset":{"description":"Time in seconds before the limit resets for the account","schema":{"type":"integer"}}},"exampleType":"generated"},"e5884458-8461-4e98-be42-e8e8ba420de1":{"description":"Not Found","content":{"application/json":{"schema":{"title":"NotFoundErrors","description":"NotFoundErrors model","type":"object","properties":{"errors":{"description":"NotFoundError errors","type":"array","items":{"title":"NotFoundError","type":"object","properties":{"code":{"description":"Error code","type":"string","const":"not-found","example":"not-found","isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["code","message"],"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"NotFoundError · object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"NotFoundError · object[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"NotFoundErrors · object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"not-found","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"headers":{"x-ratelimit-limit-user":{"description":"Number of requests allowed per minute for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-remaining":{"description":"Number of requests remaining for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-reset":{"description":"Time in seconds before the limit resets for the user","schema":{"type":"integer"}},"x-ratelimit-limit-org":{"description":"Number of requests allowed per month for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-remaining":{"description":"Number of requests remaining for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-reset":{"description":"Time in seconds before the limit resets for the account","schema":{"type":"integer"}}},"exampleType":"generated"},"c2a8623e-e796-42f4-b2c5-cb07f52de18c":{"description":"Errors","content":{"application/json":{"schema":{"title":"Errors","type":"object","properties":{"errors":{"description":"Errors","type":"array","items":{"oneOf":[{"type":"object","title":"AuthenticationError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"authentication","example":"authentication","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.0.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.0","typeLabel":"AuthenticationError · object"},{"type":"object","title":"AuthorizationError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"authorization","example":"authorization","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.1","typeLabel":"AuthorizationError · object"},{"type":"object","title":"BadRequestError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"bad-request","example":"bad-request","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.2.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.2","typeLabel":"BadRequestError · object"},{"type":"object","title":"ConflictError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"conflict","example":"conflict","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.3.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.3","typeLabel":"ConflictError · object"},{"type":"object","title":"MethodNotAllowedError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"method-not-allowed","example":"method-not-allowed","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.4.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.4","typeLabel":"MethodNotAllowedError · object"},{"type":"object","title":"NotAcceptableError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"not-acceptable","example":"not-acceptable","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.5.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.5","typeLabel":"NotAcceptableError · object"},{"type":"object","title":"NotFoundError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"not-found","example":"not-found","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.6.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.6","typeLabel":"NotFoundError · object"},{"type":"object","title":"NotImplementedError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"not-implemented","example":"not-implemented","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.7.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.7","typeLabel":"NotImplementedError · object"},{"type":"object","title":"RateLimitError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"rate-limit","example":"rate-limit","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.8.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.8","typeLabel":"RateLimitError · object"},{"type":"object","title":"ServerError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"server","example":"server","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.9.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.9","typeLabel":"ServerError · object"},{"type":"object","title":"TimeoutError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"timeout","example":"timeout","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.10.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.10","typeLabel":"TimeoutError · object"},{"type":"object","title":"UnprocessableEntityError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"unprocessable-entity","example":"unprocessable-entity","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.11.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.11","typeLabel":"UnprocessableEntityError · object"},{"type":"object","title":"UnsupportedMediaTypeError","required":["code","message"],"properties":{"code":{"description":"Error code","type":"string","const":"unsupported-media-type","example":"unsupported-media-type","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.12.message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.12","typeLabel":"UnsupportedMediaTypeError · object"},{"type":"object","title":"ValidationError","required":["code","message","param"],"properties":{"code":{"description":"Error code","type":"string","const":"validation","example":"validation","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.13.code","typeLabel":"string"},"message":{"description":"Error message","type":"string","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.13.message","typeLabel":"string"},"param":{"description":"Param the error refers to","type":"string","example":"limit","isRequired":true,"uniqueKey":"errors.items.[INDEX].oneOf.13.param","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].oneOf.13","typeLabel":"ValidationError · object"}],"uniqueKey":"errors.items.[INDEX]","typeLabel":"AuthenticationError · object | AuthorizationError · object | BadRequestError · object | ConflictError · object | MethodNotAllowedError · object | NotAcceptableError · object | NotFoundError · object | NotImplementedError · object | RateLimitError · object | ServerError · object | TimeoutError · object | UnprocessableEntityError · object | UnsupportedMediaTypeError · object | ValidationError · object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"(AuthenticationError · object | AuthorizationError · object | BadRequestError · object | ConflictError · object | MethodNotAllowedError · object | NotAcceptableError · object | NotFoundError · object | NotImplementedError · object | RateLimitError · object | ServerError · object | TimeoutError · object | UnprocessableEntityError · object | UnsupportedMediaTypeError · object | ValidationError · object)[]"}},"required":["errors"],"additionalProperties":false,"uniqueKey":"","typeLabel":"Errors · object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"code":"authentication","message":"\u003cstring>"}]}}},"exampleType":"generated"}},"headers":{"x-ratelimit-limit-user":{"description":"Number of requests allowed per minute for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-remaining":{"description":"Number of requests remaining for the user","schema":{"type":"integer"}},"x-ratelimit-limit-user-reset":{"description":"Time in seconds before the limit resets for the user","schema":{"type":"integer"}},"x-ratelimit-limit-org":{"description":"Number of requests allowed per month for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-remaining":{"description":"Number of requests remaining for the account","schema":{"type":"integer"}},"x-ratelimit-limit-org-reset":{"description":"Time in seconds before the limit resets for the account","schema":{"type":"integer"}}},"exampleType":"generated"}},"security":{"8a63f0b7-521f-4316-b4fb-e564dd0c357f":{"apiKeyAuth":{"type":"http","scheme":"bearer","description":"A static Affinity API key, presented as a bearer token.","scopes":[]}},"e77058d1-29b4-4c2d-a479-93f5eb8b924d":{"oauth2":{"type":"oauth2","description":"OAuth 2.0 authorization code flow used to obtain a bearer token to access the Affinity API on a user's behalf.","flows":{"authorizationCode":{"authorizationUrl":"https://login.affinity.co/auth/oauth2/authorize","tokenUrl":"https://login.affinity.co/auth/oauth2/token","scopes":{"mcp":"Read and write data in Affinity via the MCP server","mcp.read":"Read access to data in Affinity via the MCP server","api":"Access to all Affinity APIs on your behalf","api.read":"Read-only access to Affinity APIs on your behalf","offline_access":"Continuous access to your Affinity data while logged out"}}},"scopes":["api.read"]}}},"servers":{"e30dbe19-8523-4582-a403-60761bd25e12":{"url":"https://api.affinity.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"A static Affinity API key, presented as a bearer token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"A static Affinity API key, presented as a bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKeyAuth","name":"Authorization"}],"title":"apiKeyAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 authorization code flow used to obtain a bearer token to access the Affinity API on a user's behalf.","flows":{"authorizationCode":{"authorizationUrl":"https://login.affinity.co/auth/oauth2/authorize","tokenUrl":"https://login.affinity.co/auth/oauth2/token","scopes":{"mcp":"Read and write data in Affinity via the MCP server","mcp.read":"Read access to data in Affinity via the MCP server","api":"Access to all Affinity APIs on your behalf","api.read":"Read-only access to Affinity APIs on your behalf","offline_access":"Continuous access to your Affinity data while logged out"}}},"scopes":["api.read"]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 authorization code flow used to obtain a bearer token to access the Affinity API on a user's behalf.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"schema/temp/versions/2024-01-01.yml"},"subdomain":"affinityco","siteName":"Affinity Developer Documentation","title":"Search Notes by Keyword - Affinity Developer Documentation","relatedPagesConfig":{"enabled":true,"limit":9,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T17:44:44.299Z","originalFileLocation":"api-reference/2024-01-01/notes/search-notes-by-keyword.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=\"Search notes by keyword. The scope of the search is controlled by the request body: - Provide noteIds to limit the search to specific notes. - Provide companyId to limit the search to notes associated with a specific company. - Omit both to search across your entire account. noteIds and companyId are mutually exclusive. Returns up to limit notes ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Affinity Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_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/affinityco/CXvLshWNfONUoQ_Z/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search Notes by Keyword - Affinity Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search notes by keyword. The scope of the search is controlled by the request body: - Provide noteIds to limit the search to specific notes. - Provide companyId to limit the search to notes associated with a specific company. - Omit both to search across your entire account. noteIds and companyId are mutually exclusive. Returns up to limit notes ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Affinity Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://affinityco.mintlify.app/images/opengraph-affinity.png\">\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=\"Search Notes by Keyword - Affinity Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search notes by keyword. The scope of the search is controlled by the request body: - Provide noteIds to limit the search to specific notes. - Provide companyId to limit the search to notes associated with a specific company. - Omit both to search across your entire account. noteIds and companyId are mutually exclusive. Returns up to limit notes ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://affinityco.mintlify.app/images/opengraph-affinity.png\">\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/affinityco/CXvLshWNfONUoQ_Z/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Affinity Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3B0D3A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/2024-01-01/notes/search-notes-by-keyword.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.affinity.co/#organization\",\"name\":\"Affinity Developer Documentation\",\"url\":\"https://developer.affinity.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/affinityco/eam7hibfKwa27ik4/logo/light.svg?fit=max\u0026auto=format\u0026n=eam7hibfKwa27ik4\u0026q=85\u0026s=3903d98e7859d09064804785a73f9056\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.affinity.co#website\",\"name\":\"Affinity Developer Documentation\",\"url\":\"https://developer.affinity.co\",\"publisher\":{\"@id\":\"https://developer.affinity.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword#webpage\",\"url\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword\",\"name\":\"Search Notes by Keyword\",\"description\":\"Search notes by keyword. The scope of the search is controlled by the request body: - Provide noteIds to limit the search to specific notes. - Provide companyId to limit the search to notes associated with a specific company. - Omit both to search across your entire account. noteIds and companyId are mutually exclusive. Returns up to limit notes ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.\",\"dateModified\":\"2026-10-30T17:44:44.299Z\",\"isPartOf\":{\"@id\":\"https://developer.affinity.co#website\"},\"breadcrumb\":{\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Notes\",\"item\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/get-all-notes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search Notes by Keyword\",\"item\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword#apireference\",\"headline\":\"Search Notes by Keyword\",\"name\":\"Search Notes by Keyword\",\"description\":\"Search notes by keyword. The scope of the search is controlled by the request body: - Provide noteIds to limit the search to specific notes. - Provide companyId to limit the search to notes associated with a specific company. - Omit both to search across your entire account. noteIds and companyId are mutually exclusive. Returns up to limit notes ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched note and a single representative excerpt (a matching passage from that note). Even if a note contains multiple matching passages, it appears exactly once in the response with one excerpt.\",\"url\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword\",\"mainEntityOfPage\":{\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/notes/search-notes-by-keyword#webpage\"},\"image\":\"https://developer.affinity.co/images/opengraph-affinity.png\",\"dateModified\":\"2026-10-30T17:44:44.299Z\",\"publisher\":{\"@id\":\"https://developer.affinity.co/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.affinity.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Affinity Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Affinity Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/pages/external-api-v2/introduction"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"2026-09-17","icon":"code","description":"Latest","groups":[{"group":"Records","pages":[{"group":"Companies","expanded":false,"pages":[{"title":"Search Companies","deprecated":null,"version":null,"sidebarTitle":"Search companies","openapi":"/schema/temp/publish.yml post /v2/companies/search","href":"/api-reference/2026-09-17/companies/search-companies"},{"title":"Get all Companies","deprecated":null,"version":null,"sidebarTitle":"Get all companies","openapi":"/schema/temp/publish.yml get /v2/companies","href":"/api-reference/2026-09-17/companies/get-all-companies"},{"title":"Get a single Company","deprecated":null,"version":null,"sidebarTitle":"Get a company","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}","href":"/api-reference/2026-09-17/companies/get-a-single-company"},{"title":"Get a Company's List Entries","deprecated":null,"version":null,"sidebarTitle":"Get a company's list entries","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/list-entries","href":"/api-reference/2026-09-17/companies/get-a-companys-list-entries"},{"title":"Get a Company's Lists","deprecated":null,"version":null,"sidebarTitle":"Get a company's lists","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/lists","href":"/api-reference/2026-09-17/companies/get-a-companys-lists"},{"title":"Get Notes for a Company","deprecated":null,"version":null,"sidebarTitle":"Get a company's notes","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/notes","href":"/api-reference/2026-09-17/companies/get-notes-for-a-company"},{"title":"Get Relationships for a Company","deprecated":null,"version":null,"sidebarTitle":"Get a company's relationships","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/relationships","href":"/api-reference/2026-09-17/companies/get-relationships-for-a-company"},{"group":"Company Fields","expanded":false,"pages":[{"title":"Get metadata on Company Fields","deprecated":null,"version":null,"sidebarTitle":"Get all company fields","openapi":"/schema/temp/publish.yml get /v2/companies/fields","href":"/api-reference/2026-09-17/companies/get-metadata-on-company-fields"},{"title":"Get dropdown options for a Company Field","deprecated":null,"version":null,"sidebarTitle":"Get dropdown options","openapi":"/schema/temp/publish.yml get /v2/companies/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-09-17/companies/get-dropdown-options-for-a-company-field"}]},{"group":"Company Field Values","expanded":false,"pages":[{"title":"Get field values on a single Company","deprecated":null,"version":null,"sidebarTitle":"Get all field values","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/fields","href":"/api-reference/2026-09-17/companies/get-field-values-on-a-single-company"},{"title":"Get a single field value on a Company","deprecated":null,"version":null,"sidebarTitle":"Get a field value","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/fields/{fieldId}","href":"/api-reference/2026-09-17/companies/get-a-single-field-value-on-a-company"},{"title":"Update a single field value on a Company","deprecated":null,"version":null,"sidebarTitle":"Update a field value","openapi":"/schema/temp/publish.yml post /v2/companies/{companyId}/fields/{fieldId}","href":"/api-reference/2026-09-17/companies/update-a-single-field-value-on-a-company"},{"title":"Perform batch operations on a company's fields","deprecated":null,"version":null,"sidebarTitle":"Batch update field values","openapi":"/schema/temp/publish.yml patch /v2/companies/{companyId}/fields","href":"/api-reference/2026-09-17/companies/perform-batch-operations-on-a-companys-fields"},{"title":"Get values for a single field on a Company","deprecated":null,"version":null,"sidebarTitle":"Get a field's values","openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/fields/{fieldId}/values","href":"/api-reference/2026-09-17/companies/get-values-for-a-single-field-on-a-company"}]},{"group":"Company Merges","expanded":false,"pages":[{"title":"Get All Company Merges","deprecated":null,"version":null,"sidebarTitle":"Get all company merges","openapi":"/schema/temp/publish.yml get /v2/company-merges","href":"/api-reference/2026-09-17/company-merges/get-all-company-merges"},{"title":"Get Company Merge","deprecated":null,"version":null,"sidebarTitle":"Get a company merge","openapi":"/schema/temp/publish.yml get /v2/company-merges/{mergeId}","href":"/api-reference/2026-09-17/company-merges/get-company-merge"},{"title":"Initiate Company Merge","deprecated":null,"version":null,"sidebarTitle":"Merge companies","openapi":"/schema/temp/publish.yml post /v2/company-merges","href":"/api-reference/2026-09-17/company-merges/initiate-company-merge"},{"title":"Get All Company Merge Tasks","deprecated":null,"version":null,"sidebarTitle":"Get all merge tasks","openapi":"/schema/temp/publish.yml get /v2/tasks/company-merges","href":"/api-reference/2026-09-17/company-merges/get-all-company-merge-tasks"},{"title":"Get Company Merge Task","deprecated":null,"version":null,"sidebarTitle":"Get a merge task","openapi":"/schema/temp/publish.yml get /v2/tasks/company-merges/{taskId}","href":"/api-reference/2026-09-17/company-merges/get-company-merge-task"}]}]},{"group":"Field Value Changes","expanded":false,"pages":[{"title":"Get all field value changes","deprecated":null,"version":null,"sidebarTitle":"Get field value changes","openapi":"/schema/temp/publish.yml get /v2/field-value-changes","href":"/api-reference/2026-09-17/field-value-changes/get-all-field-value-changes"}]},{"group":"Files","expanded":false,"pages":[{"title":"Search Files by Keyword","deprecated":null,"version":null,"sidebarTitle":"Search files","openapi":"/schema/temp/publish.yml post /v2/files/search","href":"/api-reference/2026-09-17/files/search-files-by-keyword"},{"title":"Get all Files","deprecated":null,"version":null,"sidebarTitle":"Get all files","openapi":"/schema/temp/publish.yml get /v2/files","href":"/api-reference/2026-09-17/files/get-all-files"},{"title":"Get a single File","deprecated":null,"version":null,"sidebarTitle":"Get a file","openapi":"/schema/temp/publish.yml get /v2/files/{fileId}","href":"/api-reference/2026-09-17/files/get-a-single-file"}]},{"group":"Lists","expanded":false,"pages":[{"title":"Get metadata on all Lists","deprecated":null,"version":null,"sidebarTitle":"Get all lists","openapi":"/schema/temp/publish.yml get /v2/lists","href":"/api-reference/2026-09-17/lists/get-metadata-on-all-lists"},{"title":"Get metadata on a single List","deprecated":null,"version":null,"sidebarTitle":"Get a list","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}","href":"/api-reference/2026-09-17/lists/get-metadata-on-a-single-list"},{"title":"Create a List","deprecated":null,"version":null,"sidebarTitle":"Create a list","openapi":"/schema/temp/publish.yml post /v2/lists","href":"/api-reference/2026-09-17/lists/create-a-list"},{"group":"List Fields","expanded":false,"pages":[{"title":"Get metadata on a single List's Fields","deprecated":null,"version":null,"sidebarTitle":"Get all list fields","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/fields","href":"/api-reference/2026-09-17/lists/get-metadata-on-a-single-lists-fields"},{"title":"Get dropdown options for a List Field","deprecated":null,"version":null,"sidebarTitle":"Get dropdown options","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-09-17/lists/get-dropdown-options-for-a-list-field"},{"title":"Get a dropdown option for a List Field","deprecated":null,"version":null,"sidebarTitle":"Get a dropdown option","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2026-09-17/lists/get-a-dropdown-option-for-a-list-field"},{"title":"Create a dropdown option for a List Field","deprecated":null,"version":null,"sidebarTitle":"Create a dropdown option","openapi":"/schema/temp/publish.yml post /v2/lists/{listId}/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-09-17/lists/create-a-dropdown-option-for-a-list-field"},{"title":"Update a dropdown option for a List Field","deprecated":null,"version":null,"sidebarTitle":"Update a dropdown option","openapi":"/schema/temp/publish.yml post /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2026-09-17/lists/update-a-dropdown-option-for-a-list-field"},{"title":"Delete a dropdown option for a List Field","deprecated":null,"version":null,"sidebarTitle":"Delete a dropdown option","openapi":"/schema/temp/publish.yml delete /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2026-09-17/lists/delete-a-dropdown-option-for-a-list-field"}]},{"group":"List Saved Views","expanded":false,"pages":[{"title":"Get metadata on Saved Views","deprecated":null,"version":null,"sidebarTitle":"Get all saved views","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/saved-views","href":"/api-reference/2026-09-17/lists/get-metadata-on-saved-views"},{"title":"Get metadata on a single Saved View","deprecated":null,"version":null,"sidebarTitle":"Get a saved view","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/saved-views/{viewId}","href":"/api-reference/2026-09-17/lists/get-metadata-on-a-single-saved-view"},{"title":"Get all List Entries on a Saved View","deprecated":null,"version":null,"sidebarTitle":"Get saved view entries","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/saved-views/{viewId}/list-entries","href":"/api-reference/2026-09-17/lists/get-all-list-entries-on-a-saved-view"}]}]},{"group":"List Entries","expanded":false,"pages":[{"title":"Search List Entries","deprecated":null,"version":null,"sidebarTitle":"Search list entries","openapi":"/schema/temp/publish.yml post /v2/lists/{listId}/list-entries/search","href":"/api-reference/2026-09-17/lists/search-list-entries"},{"title":"Get all List Entries on a List","deprecated":null,"version":null,"sidebarTitle":"Get all list entries","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/list-entries","href":"/api-reference/2026-09-17/lists/get-all-list-entries-on-a-list"},{"title":"Get a single List Entry on a List","deprecated":null,"version":null,"sidebarTitle":"Get a list entry","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/list-entries/{listEntryId}","href":"/api-reference/2026-09-17/lists/get-a-single-list-entry-on-a-list"},{"title":"Add a List Entry to a List","deprecated":null,"version":null,"sidebarTitle":"Add a list entry","openapi":"/schema/temp/publish.yml post /v2/lists/{listId}/list-entries","href":"/api-reference/2026-09-17/lists/add-a-list-entry-to-a-list"},{"title":"Get Field Value Changes on a List Entry","deprecated":null,"version":null,"sidebarTitle":"Get field value changes","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/list-entries/{listEntryId}/field-value-changes","href":"/api-reference/2026-09-17/lists/get-field-value-changes-on-a-list-entry"},{"group":"List Entry Field Values","expanded":false,"pages":[{"title":"Get field values on a single List Entry","deprecated":null,"version":null,"sidebarTitle":"Get all field values","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields","href":"/api-reference/2026-09-17/lists/get-field-values-on-a-single-list-entry"},{"title":"Get a single field value","deprecated":null,"version":null,"sidebarTitle":"Get a field value","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}","href":"/api-reference/2026-09-17/lists/get-a-single-field-value"},{"title":"Update a single field value on a List Entry","deprecated":null,"version":null,"sidebarTitle":"Update a field value","openapi":"/schema/temp/publish.yml post /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}","href":"/api-reference/2026-09-17/lists/update-a-single-field-value-on-a-list-entry"},{"title":"Perform batch operations on a list entry's fields","deprecated":null,"version":null,"sidebarTitle":"Batch update field values","openapi":"/schema/temp/publish.yml patch /v2/lists/{listId}/list-entries/{listEntryId}/fields","href":"/api-reference/2026-09-17/lists/perform-batch-operations-on-a-list-entrys-fields"},{"title":"Get values for a single field on a List Entry","deprecated":null,"version":null,"sidebarTitle":"Get a field's values","openapi":"/schema/temp/publish.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}/values","href":"/api-reference/2026-09-17/lists/get-values-for-a-single-field-on-a-list-entry"}]}]},{"group":"Notes","expanded":false,"pages":[{"title":"Search Notes by Keyword","deprecated":null,"version":null,"sidebarTitle":"Search notes","openapi":"/schema/temp/publish.yml post /v2/notes/search","href":"/api-reference/2026-09-17/notes/search-notes-by-keyword"},{"title":"Get all Notes","deprecated":null,"version":null,"sidebarTitle":"Get all notes","openapi":"/schema/temp/publish.yml get /v2/notes","href":"/api-reference/2026-09-17/notes/get-all-notes"},{"title":"Get a single Note","deprecated":null,"version":null,"sidebarTitle":"Get a note","openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}","href":"/api-reference/2026-09-17/notes/get-a-single-note"},{"title":"Create a Note","deprecated":null,"version":null,"sidebarTitle":"Create a note","openapi":"/schema/temp/publish.yml post /v2/notes","href":"/api-reference/2026-09-17/notes/create-a-note"},{"title":"Update a single Note","deprecated":null,"version":null,"sidebarTitle":"Update a note","openapi":"/schema/temp/publish.yml post /v2/notes/{noteId}","href":"/api-reference/2026-09-17/notes/update-a-single-note"},{"title":"Delete a single Note","deprecated":null,"version":null,"sidebarTitle":"Delete a note","openapi":"/schema/temp/publish.yml delete /v2/notes/{noteId}","href":"/api-reference/2026-09-17/notes/delete-a-single-note"},{"title":"Get Companies attached to a Note","deprecated":null,"version":null,"sidebarTitle":"Get attached companies","openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}/attached-companies","href":"/api-reference/2026-09-17/notes/get-companies-attached-to-a-note"},{"title":"Get Opportunities attached to a Note","deprecated":null,"version":null,"sidebarTitle":"Get attached opportunities","openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}/attached-opportunities","href":"/api-reference/2026-09-17/notes/get-opportunities-attached-to-a-note"},{"title":"Get Persons attached to a Note","deprecated":null,"version":null,"sidebarTitle":"Get attached persons","openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}/attached-persons","href":"/api-reference/2026-09-17/notes/get-persons-attached-to-a-note"},{"title":"Get replies for a Note","deprecated":null,"version":null,"sidebarTitle":"Get note replies","openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}/replies","href":"/api-reference/2026-09-17/notes/get-replies-for-a-note"}]},{"group":"Opportunities","expanded":false,"pages":[{"title":"Get all Opportunities","deprecated":null,"version":null,"sidebarTitle":"Get all opportunities","openapi":"/schema/temp/publish.yml get /v2/opportunities","href":"/api-reference/2026-09-17/opportunities/get-all-opportunities"},{"title":"Get a single Opportunity","deprecated":null,"version":null,"sidebarTitle":"Get an opportunity","openapi":"/schema/temp/publish.yml get /v2/opportunities/{opportunityId}","href":"/api-reference/2026-09-17/opportunities/get-a-single-opportunity"},{"title":"Update an Opportunity","deprecated":null,"version":null,"sidebarTitle":"Update an opportunity","openapi":"/schema/temp/publish.yml post /v2/opportunities/{opportunityId}","href":"/api-reference/2026-09-17/opportunities/update-an-opportunity"},{"title":"Delete an Opportunity","deprecated":null,"version":null,"sidebarTitle":"Delete an opportunity","openapi":"/schema/temp/publish.yml delete /v2/opportunities/{opportunityId}","href":"/api-reference/2026-09-17/opportunities/delete-an-opportunity"},{"title":"Get Notes for an Opportunity","deprecated":null,"version":null,"sidebarTitle":"Get an opportunity's notes","openapi":"/schema/temp/publish.yml get /v2/opportunities/{opportunityId}/notes","href":"/api-reference/2026-09-17/opportunities/get-notes-for-an-opportunity"}]},{"group":"Persons","expanded":false,"pages":[{"title":"Search Persons","deprecated":null,"version":null,"sidebarTitle":"Search persons","openapi":"/schema/temp/publish.yml post /v2/persons/search","href":"/api-reference/2026-09-17/persons/search-persons"},{"title":"Get all Persons","deprecated":null,"version":null,"sidebarTitle":"Get all persons","openapi":"/schema/temp/publish.yml get /v2/persons","href":"/api-reference/2026-09-17/persons/get-all-persons"},{"title":"Get a single Person","deprecated":null,"version":null,"sidebarTitle":"Get a person","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}","href":"/api-reference/2026-09-17/persons/get-a-single-person"},{"title":"Create a Person","deprecated":null,"version":null,"sidebarTitle":"Create a person","openapi":"/schema/temp/publish.yml post /v2/persons","href":"/api-reference/2026-09-17/persons/create-a-person"},{"title":"Delete a Person","deprecated":null,"version":null,"sidebarTitle":"Delete a person","openapi":"/schema/temp/publish.yml delete /v2/persons/{personId}","href":"/api-reference/2026-09-17/persons/delete-a-person"},{"title":"Get a Person's List Entries","deprecated":null,"version":null,"sidebarTitle":"Get a person's list entries","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/list-entries","href":"/api-reference/2026-09-17/persons/get-a-persons-list-entries"},{"title":"Get a Person's Lists","deprecated":null,"version":null,"sidebarTitle":"Get a person's lists","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/lists","href":"/api-reference/2026-09-17/persons/get-a-persons-lists"},{"title":"Get Notes for a Person","deprecated":null,"version":null,"sidebarTitle":"Get a person's notes","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/notes","href":"/api-reference/2026-09-17/persons/get-notes-for-a-person"},{"title":"Get Relationships for a Person","deprecated":null,"version":null,"sidebarTitle":"Get a person's relationships","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/relationships","href":"/api-reference/2026-09-17/persons/get-relationships-for-a-person"},{"group":"Person Fields","expanded":false,"pages":[{"title":"Get metadata on Person Fields","deprecated":null,"version":null,"sidebarTitle":"Get all person fields","openapi":"/schema/temp/publish.yml get /v2/persons/fields","href":"/api-reference/2026-09-17/persons/get-metadata-on-person-fields"},{"title":"Get dropdown options for a Person Field","deprecated":null,"version":null,"sidebarTitle":"Get dropdown options","openapi":"/schema/temp/publish.yml get /v2/persons/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-09-17/persons/get-dropdown-options-for-a-person-field"}]},{"group":"Person Field Values","expanded":false,"pages":[{"title":"Get field values on a single Person","deprecated":null,"version":null,"sidebarTitle":"Get all field values","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/fields","href":"/api-reference/2026-09-17/persons/get-field-values-on-a-single-person"},{"title":"Get a single field on a Person","deprecated":null,"version":null,"sidebarTitle":"Get a field value","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/fields/{fieldId}","href":"/api-reference/2026-09-17/persons/get-a-single-field-on-a-person"},{"title":"Update a single field value on a Person","deprecated":null,"version":null,"sidebarTitle":"Update a field value","openapi":"/schema/temp/publish.yml post /v2/persons/{personId}/fields/{fieldId}","href":"/api-reference/2026-09-17/persons/update-a-single-field-value-on-a-person"},{"title":"Perform batch operations on a person's fields","deprecated":null,"version":null,"sidebarTitle":"Batch update field values","openapi":"/schema/temp/publish.yml patch /v2/persons/{personId}/fields","href":"/api-reference/2026-09-17/persons/perform-batch-operations-on-a-persons-fields"},{"title":"Get values for a single field on a Person","deprecated":null,"version":null,"sidebarTitle":"Get a field's values","openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/fields/{fieldId}/values","href":"/api-reference/2026-09-17/persons/get-values-for-a-single-field-on-a-person"}]},{"group":"Person Merges","expanded":false,"pages":[{"title":"Get All Person Merges","deprecated":null,"version":null,"sidebarTitle":"Get all person merges","openapi":"/schema/temp/publish.yml get /v2/person-merges","href":"/api-reference/2026-09-17/person-merges/get-all-person-merges"},{"title":"Get Person Merge","deprecated":null,"version":null,"sidebarTitle":"Get a person merge","openapi":"/schema/temp/publish.yml get /v2/person-merges/{mergeId}","href":"/api-reference/2026-09-17/person-merges/get-person-merge"},{"title":"Initiate Person Merge","deprecated":null,"version":null,"sidebarTitle":"Merge persons","openapi":"/schema/temp/publish.yml post /v2/person-merges","href":"/api-reference/2026-09-17/person-merges/initiate-person-merge"},{"title":"Get All Person Merge Tasks","deprecated":null,"version":null,"sidebarTitle":"Get all merge tasks","openapi":"/schema/temp/publish.yml get /v2/tasks/person-merges","href":"/api-reference/2026-09-17/person-merges/get-all-person-merge-tasks"},{"title":"Get Person Merge Task","deprecated":null,"version":null,"sidebarTitle":"Get a merge task","openapi":"/schema/temp/publish.yml get /v2/tasks/person-merges/{taskId}","href":"/api-reference/2026-09-17/person-merges/get-person-merge-task"}]}]},{"group":"Reminders","expanded":false,"pages":[{"title":"Get all Reminders","deprecated":null,"version":null,"sidebarTitle":"Get all reminders","openapi":"/schema/temp/publish.yml get /v2/reminders","href":"/api-reference/2026-09-17/reminders/get-all-reminders"},{"title":"Get a single Reminder","deprecated":null,"version":null,"sidebarTitle":"Get a reminder","openapi":"/schema/temp/publish.yml get /v2/reminders/{reminderId}","href":"/api-reference/2026-09-17/reminders/get-a-single-reminder"},{"title":"Create a Reminder","deprecated":null,"version":null,"sidebarTitle":"Create a reminder","openapi":"/schema/temp/publish.yml post /v2/reminders","href":"/api-reference/2026-09-17/reminders/create-a-reminder"},{"title":"Update a Reminder","deprecated":null,"version":null,"sidebarTitle":"Update a reminder","openapi":"/schema/temp/publish.yml post /v2/reminders/{reminderId}","href":"/api-reference/2026-09-17/reminders/update-a-reminder"},{"title":"Delete a Reminder","deprecated":null,"version":null,"sidebarTitle":"Delete a reminder","openapi":"/schema/temp/publish.yml delete /v2/reminders/{reminderId}","href":"/api-reference/2026-09-17/reminders/delete-a-reminder"}]},{"group":"Semantic Search","expanded":false,"pages":[{"title":"Semantic Search","deprecated":null,"version":null,"sidebarTitle":"Semantic search","openapi":"/schema/temp/publish.yml post /v2/semantic-search","href":"/api-reference/2026-09-17/semantic-search/semantic-search"}]},{"group":"Transcripts","expanded":false,"pages":[{"title":"Get all Transcripts","deprecated":null,"version":null,"sidebarTitle":"Get all transcripts","openapi":"/schema/temp/publish.yml get /v2/transcripts","href":"/api-reference/2026-09-17/transcripts/get-all-transcripts"},{"title":"Get a single Transcript","deprecated":null,"version":null,"sidebarTitle":"Get a transcript","openapi":"/schema/temp/publish.yml get /v2/transcripts/{transcriptId}","href":"/api-reference/2026-09-17/transcripts/get-a-single-transcript"},{"title":"Delete a single Transcript","deprecated":null,"version":null,"sidebarTitle":"Delete a transcript","openapi":"/schema/temp/publish.yml delete /v2/transcripts/{transcriptId}","href":"/api-reference/2026-09-17/transcripts/delete-a-single-transcript"},{"title":"Get fragments of a transcript","deprecated":null,"version":null,"sidebarTitle":"Get transcript fragments","openapi":"/schema/temp/publish.yml get /v2/transcripts/{transcriptId}/fragments","href":"/api-reference/2026-09-17/transcripts/get-fragments-of-a-transcript"}]}]},{"group":"Interactions","pages":[{"group":"Calls","expanded":false,"pages":[{"title":"Get metadata on all Calls","deprecated":null,"version":null,"sidebarTitle":"Get all calls","openapi":"/schema/temp/publish.yml get /v2/calls","href":"/api-reference/2026-09-17/calls/get-metadata-on-all-calls"}]},{"group":"Chat Messages","expanded":false,"pages":[{"title":"Get metadata on all Chat Messages","deprecated":null,"version":null,"sidebarTitle":"Get all chat messages","openapi":"/schema/temp/publish.yml get /v2/chat-messages","href":"/api-reference/2026-09-17/chat-messages/get-metadata-on-all-chat-messages"}]},{"group":"Emails","expanded":false,"pages":[{"title":"Get metadata on all Emails","deprecated":null,"version":null,"sidebarTitle":"Get all emails","openapi":"/schema/temp/publish.yml get /v2/emails","href":"/api-reference/2026-09-17/emails/get-metadata-on-all-emails"}]},{"group":"Meetings","expanded":false,"pages":[{"title":"Get metadata on all Meetings","deprecated":null,"version":null,"sidebarTitle":"Get all meetings","openapi":"/schema/temp/publish.yml get /v2/meetings","href":"/api-reference/2026-09-17/meetings/get-metadata-on-all-meetings"},{"title":"Get a single Meeting","deprecated":null,"version":null,"sidebarTitle":"Get a meeting","openapi":"/schema/temp/publish.yml get /v2/meetings/{meetingId}","href":"/api-reference/2026-09-17/meetings/get-a-single-meeting"}]}]},{"group":"Intelligence","pages":[{"group":"Duplicate Suggestions","expanded":false,"pages":[{"title":"Get All Company Duplicate Suggestions","deprecated":null,"version":null,"sidebarTitle":"Get company suggestions","openapi":"/schema/temp/publish.yml get /v2/duplicates/company-suggestions","href":"/api-reference/2026-09-17/company-duplicate-suggestions/get-all-company-duplicate-suggestions"},{"title":"Get All Person Duplicate Suggestions","deprecated":null,"version":null,"sidebarTitle":"Get person suggestions","openapi":"/schema/temp/publish.yml get /v2/duplicates/person-suggestions","href":"/api-reference/2026-09-17/person-duplicate-suggestions/get-all-person-duplicate-suggestions"}]},{"group":"Inferred Connections","expanded":false,"pages":[{"title":"Get Coworker Inferred Connections","deprecated":null,"version":null,"sidebarTitle":"Get coworker connections","openapi":"/schema/temp/publish.yml get /v2/inferred-connections/coworkers","href":"/api-reference/2026-09-17/inferred-connections/get-coworker-inferred-connections"},{"title":"Get Investor-Executive Inferred Connections","deprecated":null,"version":null,"sidebarTitle":"Get investor connections","openapi":"/schema/temp/publish.yml get /v2/inferred-connections/investor-executive-connections","href":"/api-reference/2026-09-17/inferred-connections/get-investor-executive-inferred-connections"}]},{"group":"Intro Paths","expanded":false,"pages":[{"title":"Get Introduction Paths","deprecated":null,"version":null,"sidebarTitle":"Get intro paths","openapi":"/schema/temp/publish.yml get /v2/intro-paths","href":"/api-reference/2026-09-17/intro-paths/get-introduction-paths"}]}]},{"group":"Workspace","pages":[{"group":"Account","expanded":false,"pages":[{"title":"Send Feedback","deprecated":null,"version":null,"sidebarTitle":"Send feedback","openapi":"/schema/temp/publish.yml post /v2/feedback","href":"/api-reference/2026-09-17/feedback/send-feedback"},{"title":"Get current user","deprecated":null,"version":null,"sidebarTitle":"Get current user","openapi":"/schema/temp/publish.yml get /v2/auth/whoami","href":"/api-reference/2026-09-17/auth/get-current-user"},{"title":"Get rate limit usage","deprecated":null,"version":null,"sidebarTitle":"Get rate limit usage","openapi":"/schema/temp/publish.yml get /v2/rate-limit","href":"/api-reference/2026-09-17/rate-limit/get-rate-limit-usage"}]},{"group":"Teams","expanded":false,"pages":[{"title":"Get metadata on all Teams","deprecated":null,"version":null,"sidebarTitle":"Get all teams","openapi":"/schema/temp/publish.yml get /v2/teams","href":"/api-reference/2026-09-17/teams/get-metadata-on-all-teams"},{"title":"Get metadata on a single Team","deprecated":null,"version":null,"sidebarTitle":"Get a team","openapi":"/schema/temp/publish.yml get /v2/teams/{teamId}","href":"/api-reference/2026-09-17/teams/get-metadata-on-a-single-team"},{"title":"Get all Lists a Team has access to","deprecated":null,"version":null,"sidebarTitle":"Get team lists","openapi":"/schema/temp/publish.yml get /v2/teams/{teamId}/accessible-lists","href":"/api-reference/2026-09-17/teams/get-all-lists-a-team-has-access-to"},{"title":"Get all members of a Team","deprecated":null,"version":null,"sidebarTitle":"Get team members","openapi":"/schema/temp/publish.yml get /v2/teams/{teamId}/members","href":"/api-reference/2026-09-17/teams/get-all-members-of-a-team"}]},{"group":"Users","expanded":false,"pages":[{"title":"Get all Users","deprecated":null,"version":null,"sidebarTitle":"Get all users","openapi":"/schema/temp/publish.yml get /v2/users","href":"/api-reference/2026-09-17/users/get-all-users"},{"title":"Get a single User","deprecated":null,"version":null,"sidebarTitle":"Get a user","openapi":"/schema/temp/publish.yml get /v2/users/{userId}","href":"/api-reference/2026-09-17/users/get-a-single-user"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"Get all Webhooks","deprecated":null,"version":null,"sidebarTitle":"Get all webhooks","openapi":"/schema/temp/publish.yml get /v2/webhooks","href":"/api-reference/2026-09-17/webhooks/get-all-webhooks"},{"title":"Get a single Webhook","deprecated":null,"version":null,"sidebarTitle":"Get a webhook","openapi":"/schema/temp/publish.yml get /v2/webhooks/{webhookId}","href":"/api-reference/2026-09-17/webhooks/get-a-single-webhook"},{"title":"Create a Webhook","deprecated":null,"version":null,"sidebarTitle":"Create a webhook","openapi":"/schema/temp/publish.yml post /v2/webhooks","href":"/api-reference/2026-09-17/webhooks/create-a-webhook"},{"title":"Update a Webhook","deprecated":null,"version":null,"sidebarTitle":"Update a webhook","openapi":"/schema/temp/publish.yml post /v2/webhooks/{webhookId}","href":"/api-reference/2026-09-17/webhooks/update-a-webhook"},{"title":"Delete a Webhook","deprecated":null,"version":null,"sidebarTitle":"Delete a webhook","openapi":"/schema/temp/publish.yml delete /v2/webhooks/{webhookId}","href":"/api-reference/2026-09-17/webhooks/delete-a-webhook"}]}]}]},{"dropdown":"2026-07-15","icon":"code","groups":[{"group":"Auth","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/auth/whoami","href":"/api-reference/2026-07-15/auth/get-current-user"}]},{"group":"Calls","pages":[{"title":"Get metadata on all Calls","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/calls","href":"/api-reference/2026-07-15/calls/get-metadata-on-all-calls"}]},{"group":"Chat Messages","pages":[{"title":"Get metadata on all Chat Messages","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/chat-messages","href":"/api-reference/2026-07-15/chat-messages/get-metadata-on-all-chat-messages"}]},{"group":"Companies","pages":[{"title":"Get all Companies","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies","href":"/api-reference/2026-07-15/companies/get-all-companies"},{"title":"Get metadata on Company Fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/fields","href":"/api-reference/2026-07-15/companies/get-metadata-on-company-fields"},{"title":"Get dropdown options for a Company Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-07-15/companies/get-dropdown-options-for-a-company-field"},{"title":"Search Companies","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/companies/search","href":"/api-reference/2026-07-15/companies/search-companies"},{"title":"Get a single Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}","href":"/api-reference/2026-07-15/companies/get-a-single-company"},{"title":"Get field values on a single Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}/fields","href":"/api-reference/2026-07-15/companies/get-field-values-on-a-single-company"},{"title":"Perform batch operations on a company's fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml patch /v2/companies/{companyId}/fields","href":"/api-reference/2026-07-15/companies/perform-batch-operations-on-a-companys-fields"},{"title":"Get a single field value on a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}/fields/{fieldId}","href":"/api-reference/2026-07-15/companies/get-a-single-field-value-on-a-company"},{"title":"Update a single field value on a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/companies/{companyId}/fields/{fieldId}","href":"/api-reference/2026-07-15/companies/update-a-single-field-value-on-a-company"},{"title":"Get a Company's List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}/list-entries","href":"/api-reference/2026-07-15/companies/get-a-companys-list-entries"},{"title":"Get a Company's Lists","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}/lists","href":"/api-reference/2026-07-15/companies/get-a-companys-lists"},{"title":"Get Notes for a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}/notes","href":"/api-reference/2026-07-15/companies/get-notes-for-a-company"},{"title":"Get Relationships for a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/companies/{companyId}/relationships","href":"/api-reference/2026-07-15/companies/get-relationships-for-a-company"}]},{"group":"Company Merges","pages":[{"title":"Get All Company Merges","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/company-merges","href":"/api-reference/2026-07-15/company-merges/get-all-company-merges"},{"title":"Initiate Company Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/company-merges","href":"/api-reference/2026-07-15/company-merges/initiate-company-merge"},{"title":"Get Company Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/company-merges/{mergeId}","href":"/api-reference/2026-07-15/company-merges/get-company-merge"},{"title":"Get All Company Merge Tasks","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/tasks/company-merges","href":"/api-reference/2026-07-15/company-merges/get-all-company-merge-tasks"},{"title":"Get Company Merge Task","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/tasks/company-merges/{taskId}","href":"/api-reference/2026-07-15/company-merges/get-company-merge-task"}]},{"group":"Company Duplicate Suggestions","pages":[{"title":"Get All Company Duplicate Suggestions","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/duplicates/company-suggestions","href":"/api-reference/2026-07-15/company-duplicate-suggestions/get-all-company-duplicate-suggestions"}]},{"group":"Person Duplicate Suggestions","pages":[{"title":"Get All Person Duplicate Suggestions","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/duplicates/person-suggestions","href":"/api-reference/2026-07-15/person-duplicate-suggestions/get-all-person-duplicate-suggestions"}]},{"group":"Emails","pages":[{"title":"Get metadata on all Emails","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/emails","href":"/api-reference/2026-07-15/emails/get-metadata-on-all-emails"}]},{"group":"Feedback","pages":[{"title":"Send Feedback","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/feedback","href":"/api-reference/2026-07-15/feedback/send-feedback"}]},{"group":"Field Value Changes","pages":[{"title":"Get all field value changes","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/field-value-changes","href":"/api-reference/2026-07-15/field-value-changes/get-all-field-value-changes"}]},{"group":"Files","pages":[{"title":"Search Files by Keyword","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/files/search","href":"/api-reference/2026-07-15/files/search-files-by-keyword"}]},{"group":"Inferred Connections","pages":[{"title":"Get Coworker Inferred Connections","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/inferred-connections/coworkers","href":"/api-reference/2026-07-15/inferred-connections/get-coworker-inferred-connections"},{"title":"Get Investor-Executive Inferred Connections","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/inferred-connections/investor-executive-connections","href":"/api-reference/2026-07-15/inferred-connections/get-investor-executive-inferred-connections"}]},{"group":"Lists","pages":[{"title":"Get metadata on all Lists","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists","href":"/api-reference/2026-07-15/lists/get-metadata-on-all-lists"},{"title":"Create a List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/lists","href":"/api-reference/2026-07-15/lists/create-a-list"},{"title":"Get metadata on a single List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}","href":"/api-reference/2026-07-15/lists/get-metadata-on-a-single-list"},{"title":"Get metadata on a single List's Fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/fields","href":"/api-reference/2026-07-15/lists/get-metadata-on-a-single-lists-fields"},{"title":"Get dropdown options for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-07-15/lists/get-dropdown-options-for-a-list-field"},{"title":"Create a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/lists/{listId}/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-07-15/lists/create-a-dropdown-option-for-a-list-field"},{"title":"Get a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2026-07-15/lists/get-a-dropdown-option-for-a-list-field"},{"title":"Update a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2026-07-15/lists/update-a-dropdown-option-for-a-list-field"},{"title":"Delete a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml delete /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2026-07-15/lists/delete-a-dropdown-option-for-a-list-field"},{"title":"Get all List Entries on a List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/list-entries","href":"/api-reference/2026-07-15/lists/get-all-list-entries-on-a-list"},{"title":"Search List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/lists/{listId}/list-entries/search","href":"/api-reference/2026-07-15/lists/search-list-entries"},{"title":"Get a single List Entry on a List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/list-entries/{listEntryId}","href":"/api-reference/2026-07-15/lists/get-a-single-list-entry-on-a-list"},{"title":"Get Field Value Changes on a List Entry","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/list-entries/{listEntryId}/field-value-changes","href":"/api-reference/2026-07-15/lists/get-field-value-changes-on-a-list-entry"},{"title":"Get field values on a single List Entry","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields","href":"/api-reference/2026-07-15/lists/get-field-values-on-a-single-list-entry"},{"title":"Perform batch operations on a list entry's fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml patch /v2/lists/{listId}/list-entries/{listEntryId}/fields","href":"/api-reference/2026-07-15/lists/perform-batch-operations-on-a-list-entrys-fields"},{"title":"Get a single field value","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}","href":"/api-reference/2026-07-15/lists/get-a-single-field-value"},{"title":"Update a single field value on a List Entry","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}","href":"/api-reference/2026-07-15/lists/update-a-single-field-value-on-a-list-entry"},{"title":"Get metadata on Saved Views","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/saved-views","href":"/api-reference/2026-07-15/lists/get-metadata-on-saved-views"},{"title":"Get metadata on a single Saved View","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/saved-views/{viewId}","href":"/api-reference/2026-07-15/lists/get-metadata-on-a-single-saved-view"},{"title":"Get all List Entries on a Saved View","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/lists/{listId}/saved-views/{viewId}/list-entries","href":"/api-reference/2026-07-15/lists/get-all-list-entries-on-a-saved-view"}]},{"group":"Meetings","pages":[{"title":"Get metadata on all Meetings","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/meetings","href":"/api-reference/2026-07-15/meetings/get-metadata-on-all-meetings"},{"title":"Get a single Meeting","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/meetings/{meetingId}","href":"/api-reference/2026-07-15/meetings/get-a-single-meeting"}]},{"group":"Notes","pages":[{"title":"Get all Notes","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/notes","href":"/api-reference/2026-07-15/notes/get-all-notes"},{"title":"Create a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/notes","href":"/api-reference/2026-07-15/notes/create-a-note"},{"title":"Search Notes by Keyword","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/notes/search","href":"/api-reference/2026-07-15/notes/search-notes-by-keyword"},{"title":"Get a single Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/notes/{noteId}","href":"/api-reference/2026-07-15/notes/get-a-single-note"},{"title":"Update a single Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/notes/{noteId}","href":"/api-reference/2026-07-15/notes/update-a-single-note"},{"title":"Delete a single Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml delete /v2/notes/{noteId}","href":"/api-reference/2026-07-15/notes/delete-a-single-note"},{"title":"Get Companies attached to a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/notes/{noteId}/attached-companies","href":"/api-reference/2026-07-15/notes/get-companies-attached-to-a-note"},{"title":"Get Opportunities attached to a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/notes/{noteId}/attached-opportunities","href":"/api-reference/2026-07-15/notes/get-opportunities-attached-to-a-note"},{"title":"Get Persons attached to a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/notes/{noteId}/attached-persons","href":"/api-reference/2026-07-15/notes/get-persons-attached-to-a-note"},{"title":"Get replies for a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/notes/{noteId}/replies","href":"/api-reference/2026-07-15/notes/get-replies-for-a-note"}]},{"group":"Opportunities","pages":[{"title":"Get all Opportunities","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/opportunities","href":"/api-reference/2026-07-15/opportunities/get-all-opportunities"},{"title":"Get a single Opportunity","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/opportunities/{opportunityId}","href":"/api-reference/2026-07-15/opportunities/get-a-single-opportunity"},{"title":"Get Notes for an Opportunity","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/opportunities/{opportunityId}/notes","href":"/api-reference/2026-07-15/opportunities/get-notes-for-an-opportunity"}]},{"group":"Person Merges","pages":[{"title":"Get All Person Merges","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/person-merges","href":"/api-reference/2026-07-15/person-merges/get-all-person-merges"},{"title":"Initiate Person Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/person-merges","href":"/api-reference/2026-07-15/person-merges/initiate-person-merge"},{"title":"Get Person Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/person-merges/{mergeId}","href":"/api-reference/2026-07-15/person-merges/get-person-merge"},{"title":"Get All Person Merge Tasks","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/tasks/person-merges","href":"/api-reference/2026-07-15/person-merges/get-all-person-merge-tasks"},{"title":"Get Person Merge Task","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/tasks/person-merges/{taskId}","href":"/api-reference/2026-07-15/person-merges/get-person-merge-task"}]},{"group":"Persons","pages":[{"title":"Get all Persons","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons","href":"/api-reference/2026-07-15/persons/get-all-persons"},{"title":"Create a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/persons","href":"/api-reference/2026-07-15/persons/create-a-person"},{"title":"Get metadata on Person Fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/fields","href":"/api-reference/2026-07-15/persons/get-metadata-on-person-fields"},{"title":"Get dropdown options for a Person Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/fields/{fieldId}/dropdown-options","href":"/api-reference/2026-07-15/persons/get-dropdown-options-for-a-person-field"},{"title":"Search Persons","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/persons/search","href":"/api-reference/2026-07-15/persons/search-persons"},{"title":"Get a single Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}","href":"/api-reference/2026-07-15/persons/get-a-single-person"},{"title":"Delete a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml delete /v2/persons/{personId}","href":"/api-reference/2026-07-15/persons/delete-a-person"},{"title":"Get field values on a single Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}/fields","href":"/api-reference/2026-07-15/persons/get-field-values-on-a-single-person"},{"title":"Perform batch operations on a person's fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml patch /v2/persons/{personId}/fields","href":"/api-reference/2026-07-15/persons/perform-batch-operations-on-a-persons-fields"},{"title":"Get a single field on a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}/fields/{fieldId}","href":"/api-reference/2026-07-15/persons/get-a-single-field-on-a-person"},{"title":"Update a single field value on a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/persons/{personId}/fields/{fieldId}","href":"/api-reference/2026-07-15/persons/update-a-single-field-value-on-a-person"},{"title":"Get a Person's List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}/list-entries","href":"/api-reference/2026-07-15/persons/get-a-persons-list-entries"},{"title":"Get a Person's Lists","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}/lists","href":"/api-reference/2026-07-15/persons/get-a-persons-lists"},{"title":"Get Notes for a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}/notes","href":"/api-reference/2026-07-15/persons/get-notes-for-a-person"},{"title":"Get Relationships for a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/persons/{personId}/relationships","href":"/api-reference/2026-07-15/persons/get-relationships-for-a-person"}]},{"group":"Rate Limit","pages":[{"title":"Get rate limit usage","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/rate-limit","href":"/api-reference/2026-07-15/rate-limit/get-rate-limit-usage"}]},{"group":"Reminders","pages":[{"title":"Get all Reminders","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/reminders","href":"/api-reference/2026-07-15/reminders/get-all-reminders"},{"title":"Create a Reminder","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/reminders","href":"/api-reference/2026-07-15/reminders/create-a-reminder"},{"title":"Get a single Reminder","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/reminders/{reminderId}","href":"/api-reference/2026-07-15/reminders/get-a-single-reminder"},{"title":"Delete a Reminder","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml delete /v2/reminders/{reminderId}","href":"/api-reference/2026-07-15/reminders/delete-a-reminder"}]},{"group":"Semantic Search","pages":[{"title":"Semantic Search","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/semantic-search","href":"/api-reference/2026-07-15/semantic-search/semantic-search"}]},{"group":"Transcripts","pages":[{"title":"Get all Transcripts","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/transcripts","href":"/api-reference/2026-07-15/transcripts/get-all-transcripts"},{"title":"Get a single Transcript","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/transcripts/{transcriptId}","href":"/api-reference/2026-07-15/transcripts/get-a-single-transcript"},{"title":"Get fragments of a transcript","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/transcripts/{transcriptId}/fragments","href":"/api-reference/2026-07-15/transcripts/get-fragments-of-a-transcript"}]},{"group":"Users","pages":[{"title":"Get all Users","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/users","href":"/api-reference/2026-07-15/users/get-all-users"},{"title":"Get a single User","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/users/{userId}","href":"/api-reference/2026-07-15/users/get-a-single-user"}]},{"group":"Webhooks","pages":[{"title":"Get all Webhooks","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/webhooks","href":"/api-reference/2026-07-15/webhooks/get-all-webhooks"},{"title":"Create a Webhook","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/webhooks","href":"/api-reference/2026-07-15/webhooks/create-a-webhook"},{"title":"Get a single Webhook","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml get /v2/webhooks/{webhookId}","href":"/api-reference/2026-07-15/webhooks/get-a-single-webhook"},{"title":"Update a Webhook","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml post /v2/webhooks/{webhookId}","href":"/api-reference/2026-07-15/webhooks/update-a-webhook"},{"title":"Delete a Webhook","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2026-07-15.yml delete /v2/webhooks/{webhookId}","href":"/api-reference/2026-07-15/webhooks/delete-a-webhook"}]}]},{"dropdown":"2024-01-01","icon":"code","groups":[{"group":"Auth","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/auth/whoami","href":"/api-reference/2024-01-01/auth/get-current-user"}]},{"group":"Calls","pages":[{"title":"Get metadata on all Calls","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/calls","href":"/api-reference/2024-01-01/calls/get-metadata-on-all-calls"}]},{"group":"Chat Messages","pages":[{"title":"Get metadata on all Chat Messages","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/chat-messages","href":"/api-reference/2024-01-01/chat-messages/get-metadata-on-all-chat-messages"}]},{"group":"Companies","pages":[{"title":"Get all Companies","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies","href":"/api-reference/2024-01-01/companies/get-all-companies"},{"title":"Get metadata on Company Fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/fields","href":"/api-reference/2024-01-01/companies/get-metadata-on-company-fields"},{"title":"Get dropdown options for a Company Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/fields/{fieldId}/dropdown-options","href":"/api-reference/2024-01-01/companies/get-dropdown-options-for-a-company-field"},{"title":"Search Companies","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/companies/search","href":"/api-reference/2024-01-01/companies/search-companies"},{"title":"Get a single Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}","href":"/api-reference/2024-01-01/companies/get-a-single-company"},{"title":"Get field values on a single Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}/fields","href":"/api-reference/2024-01-01/companies/get-field-values-on-a-single-company"},{"title":"Perform batch operations on a company's fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml patch /v2/companies/{companyId}/fields","href":"/api-reference/2024-01-01/companies/perform-batch-operations-on-a-companys-fields"},{"title":"Get a single field value on a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}/fields/{fieldId}","href":"/api-reference/2024-01-01/companies/get-a-single-field-value-on-a-company"},{"title":"Update a single field value on a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/companies/{companyId}/fields/{fieldId}","href":"/api-reference/2024-01-01/companies/update-a-single-field-value-on-a-company"},{"title":"Get a Company's List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}/list-entries","href":"/api-reference/2024-01-01/companies/get-a-companys-list-entries"},{"title":"Get a Company's Lists","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}/lists","href":"/api-reference/2024-01-01/companies/get-a-companys-lists"},{"title":"Get Notes for a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}/notes","href":"/api-reference/2024-01-01/companies/get-notes-for-a-company"},{"title":"Get Relationships for a Company","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/companies/{companyId}/relationships","href":"/api-reference/2024-01-01/companies/get-relationships-for-a-company"}]},{"group":"Company Merges","pages":[{"title":"Get All Company Merges","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/company-merges","href":"/api-reference/2024-01-01/company-merges/get-all-company-merges"},{"title":"Initiate Company Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/company-merges","href":"/api-reference/2024-01-01/company-merges/initiate-company-merge"},{"title":"Get Company Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/company-merges/{mergeId}","href":"/api-reference/2024-01-01/company-merges/get-company-merge"},{"title":"Get All Company Merge Tasks","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/tasks/company-merges","href":"/api-reference/2024-01-01/company-merges/get-all-company-merge-tasks"},{"title":"Get Company Merge Task","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/tasks/company-merges/{taskId}","href":"/api-reference/2024-01-01/company-merges/get-company-merge-task"}]},{"group":"Emails","pages":[{"title":"Get metadata on all Emails","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/emails","href":"/api-reference/2024-01-01/emails/get-metadata-on-all-emails"}]},{"group":"Feedback","pages":[{"title":"Send Feedback","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/feedback","href":"/api-reference/2024-01-01/feedback/send-feedback"}]},{"group":"Field Value Changes","pages":[{"title":"Get all field value changes","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/field-value-changes","href":"/api-reference/2024-01-01/field-value-changes/get-all-field-value-changes"}]},{"group":"Files","pages":[{"title":"Search Files by Keyword","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/files/search","href":"/api-reference/2024-01-01/files/search-files-by-keyword"}]},{"group":"Inferred Connections","pages":[{"title":"Get Coworker Inferred Connections","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/inferred-connections/coworkers","href":"/api-reference/2024-01-01/inferred-connections/get-coworker-inferred-connections"},{"title":"Get Investor-Executive Inferred Connections","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/inferred-connections/investor-executive-connections","href":"/api-reference/2024-01-01/inferred-connections/get-investor-executive-inferred-connections"}]},{"group":"Lists","pages":[{"title":"Get metadata on all Lists","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists","href":"/api-reference/2024-01-01/lists/get-metadata-on-all-lists"},{"title":"Create a List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/lists","href":"/api-reference/2024-01-01/lists/create-a-list"},{"title":"Get metadata on a single List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}","href":"/api-reference/2024-01-01/lists/get-metadata-on-a-single-list"},{"title":"Get metadata on a single List's Fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/fields","href":"/api-reference/2024-01-01/lists/get-metadata-on-a-single-lists-fields"},{"title":"Get dropdown options for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/fields/{fieldId}/dropdown-options","href":"/api-reference/2024-01-01/lists/get-dropdown-options-for-a-list-field"},{"title":"Create a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/lists/{listId}/fields/{fieldId}/dropdown-options","href":"/api-reference/2024-01-01/lists/create-a-dropdown-option-for-a-list-field"},{"title":"Get a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2024-01-01/lists/get-a-dropdown-option-for-a-list-field"},{"title":"Update a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2024-01-01/lists/update-a-dropdown-option-for-a-list-field"},{"title":"Delete a dropdown option for a List Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml delete /v2/lists/{listId}/fields/{fieldId}/dropdown-options/{dropdownOptionId}","href":"/api-reference/2024-01-01/lists/delete-a-dropdown-option-for-a-list-field"},{"title":"Get all List Entries on a List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/list-entries","href":"/api-reference/2024-01-01/lists/get-all-list-entries-on-a-list"},{"title":"Search List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/lists/{listId}/list-entries/search","href":"/api-reference/2024-01-01/lists/search-list-entries"},{"title":"Get a single List Entry on a List","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/list-entries/{listEntryId}","href":"/api-reference/2024-01-01/lists/get-a-single-list-entry-on-a-list"},{"title":"Get Field Value Changes on a List Entry","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/list-entries/{listEntryId}/field-value-changes","href":"/api-reference/2024-01-01/lists/get-field-value-changes-on-a-list-entry"},{"title":"Get field values on a single List Entry","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields","href":"/api-reference/2024-01-01/lists/get-field-values-on-a-single-list-entry"},{"title":"Perform batch operations on a list entry's fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml patch /v2/lists/{listId}/list-entries/{listEntryId}/fields","href":"/api-reference/2024-01-01/lists/perform-batch-operations-on-a-list-entrys-fields"},{"title":"Get a single field value","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}","href":"/api-reference/2024-01-01/lists/get-a-single-field-value"},{"title":"Update a single field value on a List Entry","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/lists/{listId}/list-entries/{listEntryId}/fields/{fieldId}","href":"/api-reference/2024-01-01/lists/update-a-single-field-value-on-a-list-entry"},{"title":"Get metadata on Saved Views","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/saved-views","href":"/api-reference/2024-01-01/lists/get-metadata-on-saved-views"},{"title":"Get metadata on a single Saved View","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/saved-views/{viewId}","href":"/api-reference/2024-01-01/lists/get-metadata-on-a-single-saved-view"},{"title":"Get all List Entries on a Saved View","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/lists/{listId}/saved-views/{viewId}/list-entries","href":"/api-reference/2024-01-01/lists/get-all-list-entries-on-a-saved-view"}]},{"group":"Meetings","pages":[{"title":"Get metadata on all Meetings","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/meetings","href":"/api-reference/2024-01-01/meetings/get-metadata-on-all-meetings"}]},{"group":"Notes","pages":[{"title":"Get all Notes","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/notes","href":"/api-reference/2024-01-01/notes/get-all-notes"},{"title":"Create a Note","description":"Create a new note. By default it is authored by the calling user; set `creator` to attribute\nit to a different internal person in your organization. Notes can be attached directly to\nentities (`Persons`, `Companies`, `Opportunities`), anchored to an interaction (`meeting`,\n`call`, or `chat message`), or written as a reply to an existing note.\n\nThe `type` field selects the shape of the request body. AI Notetaker note types\n(`ai-notetaker`, `ai-notetaker-reply`) are system-generated and cannot be created through\nthis endpoint.\n\n| **`type`** | **Description** | **Required** | **Optional** |\n|------------|-----------------|--------------|--------------|\n| `entities` | A note attached directly to one or more entities. | `content`, and at least one of `persons` / `companies` / `opportunities`. | Any combination of `persons` / `companies` / `opportunities`. |\n| `interaction` | A note anchored to a meeting, call, or chat message. | `content`, `interaction.{type,id}`. | `persons` / `companies` / `opportunities`, added as direct associations on top of the interaction's own participants. |\n| `user-reply` | A reply to an existing root note. Replies have no entity associations or interaction attachment of their own. | `content`, `parent.id` (must reference an existing root note the caller can access). | None |\n\nBy default a note is authored by the calling user. To attribute a note to a different member\nof your organization, set the optional `creator` field to reference that person by id. The\nreferenced person must be an active internal person in your organization.\n\nBy default a note's creation time is the time of the request. To backfill a historical note,\nset the optional `createdAt` field to the time the note should be recorded as created.\n\n**Body content.** `content.html` is rendered HTML that must use only the allowed tags;\nsubmitting restricted tags, attributes, URL schemes, or mention spans will cause the request to\nfail. See the request examples below for representative payloads.\n","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/notes","href":"/api-reference/2024-01-01/notes/create-a-note"},{"title":"Search Notes by Keyword","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/notes/search","href":"/api-reference/2024-01-01/notes/search-notes-by-keyword"},{"title":"Get a single Note","description":"Get a Note with a given id","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/notes/{noteId}","href":"/api-reference/2024-01-01/notes/get-a-single-note"},{"title":"Update a single Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/notes/{noteId}","href":"/api-reference/2024-01-01/notes/update-a-single-note"},{"title":"Delete a single Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml delete /v2/notes/{noteId}","href":"/api-reference/2024-01-01/notes/delete-a-single-note"},{"title":"Get Companies attached to a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/notes/{noteId}/attached-companies","href":"/api-reference/2024-01-01/notes/get-companies-attached-to-a-note"},{"title":"Get Opportunities attached to a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/notes/{noteId}/attached-opportunities","href":"/api-reference/2024-01-01/notes/get-opportunities-attached-to-a-note"},{"title":"Get Persons attached to a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/notes/{noteId}/attached-persons","href":"/api-reference/2024-01-01/notes/get-persons-attached-to-a-note"},{"title":"Get replies for a Note","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/notes/{noteId}/replies","href":"/api-reference/2024-01-01/notes/get-replies-for-a-note"}]},{"group":"Opportunities","pages":[{"title":"Get all Opportunities","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/opportunities","href":"/api-reference/2024-01-01/opportunities/get-all-opportunities"},{"title":"Get a single Opportunity","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/opportunities/{opportunityId}","href":"/api-reference/2024-01-01/opportunities/get-a-single-opportunity"},{"title":"Get Notes for an Opportunity","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/opportunities/{opportunityId}/notes","href":"/api-reference/2024-01-01/opportunities/get-notes-for-an-opportunity"}]},{"group":"Person Merges","pages":[{"title":"Get All Person Merges","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/person-merges","href":"/api-reference/2024-01-01/person-merges/get-all-person-merges"},{"title":"Initiate Person Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/person-merges","href":"/api-reference/2024-01-01/person-merges/initiate-person-merge"},{"title":"Get Person Merge","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/person-merges/{mergeId}","href":"/api-reference/2024-01-01/person-merges/get-person-merge"},{"title":"Get All Person Merge Tasks","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/tasks/person-merges","href":"/api-reference/2024-01-01/person-merges/get-all-person-merge-tasks"},{"title":"Get Person Merge Task","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/tasks/person-merges/{taskId}","href":"/api-reference/2024-01-01/person-merges/get-person-merge-task"}]},{"group":"Persons","pages":[{"title":"Get all Persons","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons","href":"/api-reference/2024-01-01/persons/get-all-persons"},{"title":"Get metadata on Person Fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/fields","href":"/api-reference/2024-01-01/persons/get-metadata-on-person-fields"},{"title":"Get dropdown options for a Person Field","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/fields/{fieldId}/dropdown-options","href":"/api-reference/2024-01-01/persons/get-dropdown-options-for-a-person-field"},{"title":"Search Persons","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/persons/search","href":"/api-reference/2024-01-01/persons/search-persons"},{"title":"Get a single Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}","href":"/api-reference/2024-01-01/persons/get-a-single-person"},{"title":"Get field values on a single Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}/fields","href":"/api-reference/2024-01-01/persons/get-field-values-on-a-single-person"},{"title":"Perform batch operations on a person's fields","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml patch /v2/persons/{personId}/fields","href":"/api-reference/2024-01-01/persons/perform-batch-operations-on-a-persons-fields"},{"title":"Get a single field on a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}/fields/{fieldId}","href":"/api-reference/2024-01-01/persons/get-a-single-field-on-a-person"},{"title":"Update a single field value on a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/persons/{personId}/fields/{fieldId}","href":"/api-reference/2024-01-01/persons/update-a-single-field-value-on-a-person"},{"title":"Get a Person's List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}/list-entries","href":"/api-reference/2024-01-01/persons/get-a-persons-list-entries"},{"title":"Get a Person's Lists","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}/lists","href":"/api-reference/2024-01-01/persons/get-a-persons-lists"},{"title":"Get Notes for a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}/notes","href":"/api-reference/2024-01-01/persons/get-notes-for-a-person"},{"title":"Get Relationships for a Person","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/persons/{personId}/relationships","href":"/api-reference/2024-01-01/persons/get-relationships-for-a-person"}]},{"group":"Reminders","pages":[{"title":"Get all Reminders","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/reminders","href":"/api-reference/2024-01-01/reminders/get-all-reminders"},{"title":"Create a Reminder","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/reminders","href":"/api-reference/2024-01-01/reminders/create-a-reminder"}]},{"group":"Semantic Search","pages":[{"title":"Semantic Search","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml post /v2/semantic-search","href":"/api-reference/2024-01-01/semantic-search/semantic-search"}]},{"group":"Transcripts","pages":[{"title":"Get all Transcripts","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/transcripts","href":"/api-reference/2024-01-01/transcripts/get-all-transcripts"},{"title":"Get a single Transcript","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/transcripts/{transcriptId}","href":"/api-reference/2024-01-01/transcripts/get-a-single-transcript"},{"title":"Get fragments of a transcript","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/transcripts/{transcriptId}/fragments","href":"/api-reference/2024-01-01/transcripts/get-fragments-of-a-transcript"}]},{"group":"Users","pages":[{"title":"Get all Users","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/users","href":"/api-reference/2024-01-01/users/get-all-users"},{"title":"Get a single User","deprecated":null,"version":null,"openapi":"/schema/temp/versions/2024-01-01.yml get /v2/users/{userId}","href":"/api-reference/2024-01-01/users/get-a-single-user"}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/pages/mcp/introduction"}]},{"tab":"Data Share","pages":[{"title":"Data Share","href":"/pages/data-share/overview"}]}]},"basePath":"","title":"Search Notes by Keyword - Affinity Developer Documentation","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}