Search files by keyword. The scope of the search is controlled by the request body:
Provide fileIds to limit the search to specific files.
Provide companyId to limit the search to files associated with a specific company.
Omit both to search across your entire account.
fileIds and companyId are mutually exclusive.
Returns up to limit files ordered by relevance. Prompts with no strong matches may
still return low-relevance results.
Each result contains a matched file and a single representative excerpt (a matching
passage from that file). Even if a file contains multiple matching passages, it appears
exactly once in the response with one excerpt.
Matching file results, one per file, 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"},"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":"6ae0da7f28d2a787b16ac47f","collectionId":"0422b767-b1fa-4e83-9cf4-b03a3c7a0c37","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0da7f28d2a787b16ac47f"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0da7f28d2a787b16ac47f","clientVersion":"0.0.4021","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":"2024-01-01","count":87},{"language":"default","tag":"Lists","count":62},{"language":"default","tag":"Data Share","count":46},{"language":"default","tag":"Persons","count":44},{"language":"default","tag":"Companies","count":40},{"language":"default","tag":"V1_0","count":37},{"language":"default","tag":"Notes","count":30}]},"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":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"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}#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/files/search-files-by-keyword","slug":"/api-reference/2024-01-01/files/search-files-by-keyword","pageMetadata":{"title":"Search Files by Keyword","description":"Search files by keyword. The scope of the search is controlled by the request body:\n\n- Provide `fileIds` to limit the search to specific files.\n- Provide `companyId` to limit the search to files associated with a specific company.\n- Omit both to search across your entire account.\n\n`fileIds` and `companyId` are mutually exclusive.\n\nReturns up to `limit` files ordered by relevance. Prompts with no strong matches may\nstill return low-relevance results.\n\nEach result contains a matched file and a single representative excerpt (a matching\npassage from that file). Even if a file 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/files/search","href":"/api-reference/2024-01-01/files/search-files-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 files 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: \"fileIds\"\n }), \" to limit the search to specific files.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Provide \", _jsx(_components.code, {\n children: \"companyId\"\n }), \" to limit the search to files 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: \"fileIds\"\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 }), \" files 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 file and a single representative excerpt (a matching\\npassage from that file). Even if a file 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 Files by Keyword","description":"Search files by keyword. The scope of the search is controlled by the request body:\n\n- Provide `fileIds` to limit the search to specific files.\n- Provide `companyId` to limit the search to files associated with a specific company.\n- Omit both to search across your entire account.\n\n`fileIds` and `companyId` are mutually exclusive.\n\nReturns up to `limit` files ordered by relevance. Prompts with no strong matches may\nstill return low-relevance results.\n\nEach result contains a matched file and a single representative excerpt (a matching\npassage from that file). Even if a file 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/files/search","href":"/api-reference/2024-01-01/files/search-files-by-keyword","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/affinityco/8a6c3f4313845c2a/amplitude.js"],"openApiReferenceData":{"operation":{"x-operation-type":"retrieval-multiple-search","description":"Search files by keyword. The scope of the search is controlled by the request body:\n\n- Provide `fileIds` to limit the search to specific files.\n- Provide `companyId` to limit the search to files associated with a specific company.\n- Omit both to search across your entire account.\n\n`fileIds` and `companyId` are mutually exclusive.\n\nReturns up to `limit` files ordered by relevance. Prompts with no strong matches may\nstill return low-relevance results.\n\nEach result contains a matched file and a single representative excerpt (a matching\npassage from that file). Even if a file contains multiple matching passages, it appears\nexactly once in the response with one excerpt.\n","summary":"Search Files by Keyword","operationId":"v2_files_search__POST","security":["b38c02e7-80d3-4bfa-976b-79345af1dc22","12608f65-396e-40c8-a9b7-ca244e96317d"],"tags":["Files"],"requestBody":"c497188a-063e-4566-8d4b-39849a23ac14","responses":{"201":"34953454-2595-4a38-9c82-48a5efa39f3c","400":"2afdee36-786b-4b45-a886-b3cf9b7dbe8f","404":"06dd87bc-3ffd-431c-9089-8fce3bd76457","default":"44d93c5e-e0a3-4a15-ba35-db15d04a8b09"},"method":"post","type":"path","servers":["e30dbe19-8523-4582-a403-60761bd25e12"],"path":"/v2/files/search","baseUrlOptions":["https://api.affinity.co"],"title":"Search Files by Keyword","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"File Keyword Search Criteria (org-wide or by file IDs)","description":"Search all files in the org, or limit to specific file IDs.","required":["prompt"],"properties":{"prompt":{"description":"The search query. Returns up to `limit` files ordered by relevance. Prompts with\nno strong matches may still return low-relevance results.\n","type":"string","minLength":3,"maxLength":500,"example":"revenue projections pitch deck","examples":["revenue projections pitch deck"],"isRequired":true,"uniqueKey":"oneOf.0.prompt","typeLabel":"string"},"fileIds":{"description":"Limit search to these specific files. Omit for org-wide search.","type":"array","items":{"type":"integer","format":"int32","minimum":1,"maximum":2147483647,"uniqueKey":"oneOf.0.fileIds.items.[INDEX]","typeLabel":"integer\u003cint32>"},"maxItems":100,"examples":[[1,2]],"uniqueKey":"oneOf.0.fileIds","typeLabel":"integer\u003cint32>[]"},"limit":{"description":"Maximum number of files 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":"File Keyword Search Criteria (org-wide or by file IDs) · object"},{"type":"object","title":"File Keyword Search Criteria (by company)","description":"Search files associated with a specific company.","required":["prompt"],"properties":{"prompt":{"description":"The search query. Returns up to `limit` files ordered by relevance. Prompts with\nno strong matches may still return low-relevance results.\n","type":"string","minLength":3,"maxLength":500,"example":"revenue projections pitch deck","examples":["revenue projections pitch deck"],"isRequired":true,"uniqueKey":"oneOf.1.prompt","typeLabel":"string"},"companyId":{"description":"Restrict search to files 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 files 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":"File Keyword Search Criteria (by company) · object"}],"uniqueKey":"","typeLabel":"File Keyword Search Criteria (org-wide or by file IDs) · object | File Keyword Search Criteria (by company) · object"},"examples":{"Example":{"title":"Example","value":{"prompt":"revenue projections pitch deck","fileIds":[1,2],"limit":20}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"34953454-2595-4a38-9c82-48a5efa39f3c":{"description":"Created","content":{"application/json":{"schema":{"title":"files.KeywordSearchResult","description":"Results of a keyword search over files.","type":"object","properties":{"data":{"description":"Matching file results, one per file, ordered by relevance.","type":"array","maxItems":100,"items":{"title":"files.SearchResult","description":"A matched file and a matching passage. Each file appears at most once per response, regardless of how many passages matched.","type":"object","properties":{"file":{"description":"The matched file.","type":"object","properties":{"id":{"description":"The file's unique identifier.","type":"integer","format":"int32","minimum":1,"maximum":2147483647,"examples":[1],"isRequired":true,"uniqueKey":"data.items.[INDEX].file.id","typeLabel":"integer\u003cint32>"},"name":{"description":"The file name.","type":"string","example":"pitch-deck-q3-2024.pdf","examples":["pitch-deck-q3-2024.pdf"],"isRequired":true,"uniqueKey":"data.items.[INDEX].file.name","typeLabel":"string"}},"required":["id","name"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data.items.[INDEX].file","typeLabel":"object"},"pageNumber":{"oneOf":[{"description":"The page where this passage was found. Null for files without page structure.","type":"integer","format":"int32","minimum":1,"maximum":10000,"example":3,"examples":[3],"isRequired":true,"uniqueKey":"data.items.[INDEX].pageNumber.oneOf.0","typeLabel":"integer\u003cint32>"},{"description":"The page where this passage was found. Null for files without page structure.","type":"null","format":"int32","minimum":1,"maximum":10000,"example":3,"examples":[3],"isRequired":true,"uniqueKey":"data.items.[INDEX].pageNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.items.[INDEX].pageNumber","typeLabel":"integer\u003cint32> | null"},"preview":{"description":"The matching passage, up to 2,000 characters.","type":"string","maxLength":2000,"example":"Projected ARR of $12M by end of Q4 2024, with 80% gross margin.","examples":["Projected ARR of $12M by end of Q4 2024, with 80% gross margin."],"isRequired":true,"uniqueKey":"data.items.[INDEX].preview","typeLabel":"string"}},"required":["file","pageNumber","preview"],"additionalProperties":false,"uniqueKey":"data.items.[INDEX]","typeLabel":"files.SearchResult · object"},"isRequired":true,"uniqueKey":"data","typeLabel":"files.SearchResult · object[]"}},"required":["data"],"additionalProperties":false,"uniqueKey":"","typeLabel":"files.KeywordSearchResult · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"file":{"id":1,"name":"pitch-deck-q3-2024.pdf"},"pageNumber":3,"preview":"Projected ARR of $12M by end of Q4 2024, with 80% gross margin."}]}}},"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"},"2afdee36-786b-4b45-a886-b3cf9b7dbe8f":{"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"},"06dd87bc-3ffd-431c-9089-8fce3bd76457":{"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"},"44d93c5e-e0a3-4a15-ba35-db15d04a8b09":{"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":{"b38c02e7-80d3-4bfa-976b-79345af1dc22":{"apiKeyAuth":{"type":"http","scheme":"bearer","description":"A static Affinity API key, presented as a bearer token.","scopes":[]}},"12608f65-396e-40c8-a9b7-ca244e96317d":{"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 Files by Keyword - Affinity Developer Documentation","relatedPagesConfig":{"enabled":true,"limit":9,"mode":"automatic"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T17:09:03.331Z","originalFileLocation":"api-reference/2024-01-01/files/search-files-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 files by keyword. The scope of the search is controlled by the request body: - Provide fileIds to limit the search to specific files. - Provide companyId to limit the search to files associated with a specific company. - Omit both to search across your entire account. fileIds and companyId are mutually exclusive. Returns up to limit files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file 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 Files by Keyword - Affinity Developer Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search files by keyword. The scope of the search is controlled by the request body: - Provide fileIds to limit the search to specific files. - Provide companyId to limit the search to files associated with a specific company. - Omit both to search across your entire account. fileIds and companyId are mutually exclusive. Returns up to limit files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file 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/files/search-files-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 Files by Keyword - Affinity Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search files by keyword. The scope of the search is controlled by the request body: - Provide fileIds to limit the search to specific files. - Provide companyId to limit the search to files associated with a specific company. - Omit both to search across your entire account. fileIds and companyId are mutually exclusive. Returns up to limit files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file 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/files/search-files-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/files/search-files-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/files/search-files-by-keyword#webpage\",\"url\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword\",\"name\":\"Search Files by Keyword\",\"description\":\"Search files by keyword. The scope of the search is controlled by the request body: - Provide fileIds to limit the search to specific files. - Provide companyId to limit the search to files associated with a specific company. - Omit both to search across your entire account. fileIds and companyId are mutually exclusive. Returns up to limit files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file contains multiple matching passages, it appears exactly once in the response with one excerpt.\",\"dateModified\":\"2026-10-27T17:09:03.331Z\",\"isPartOf\":{\"@id\":\"https://developer.affinity.co#website\"},\"breadcrumb\":{\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Affinity Developer Documentation\",\"item\":\"https://developer.affinity.co\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search Files by Keyword\",\"item\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword#apireference\",\"headline\":\"Search Files by Keyword\",\"name\":\"Search Files by Keyword\",\"description\":\"Search files by keyword. The scope of the search is controlled by the request body: - Provide fileIds to limit the search to specific files. - Provide companyId to limit the search to files associated with a specific company. - Omit both to search across your entire account. fileIds and companyId are mutually exclusive. Returns up to limit files ordered by relevance. Prompts with no strong matches may still return low-relevance results. Each result contains a matched file and a single representative excerpt (a matching passage from that file). Even if a file contains multiple matching passages, it appears exactly once in the response with one excerpt.\",\"url\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword\",\"mainEntityOfPage\":{\"@id\":\"https://developer.affinity.co/api-reference/2024-01-01/files/search-files-by-keyword#webpage\"},\"image\":\"https://developer.affinity.co/images/opengraph-affinity.png\",\"dateModified\":\"2026-10-27T17:09:03.331Z\",\"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":"Auth","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/auth/whoami","href":"/api-reference/2026-09-17/auth/get-current-user"}]},{"group":"Calls","pages":[{"title":"Get metadata on all Calls","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/calls","href":"/api-reference/2026-09-17/calls/get-metadata-on-all-calls"}]},{"group":"Chat Messages","pages":[{"title":"Get metadata on all Chat Messages","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/chat-messages","href":"/api-reference/2026-09-17/chat-messages/get-metadata-on-all-chat-messages"}]},{"group":"Companies","pages":[{"title":"Get all Companies","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/companies","href":"/api-reference/2026-09-17/companies/get-all-companies"},{"title":"Get metadata on Company Fields","deprecated":null,"version":null,"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,"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"},{"title":"Search Companies","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/companies/search","href":"/api-reference/2026-09-17/companies/search-companies"},{"title":"Get a single Company","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}","href":"/api-reference/2026-09-17/companies/get-a-single-company"},{"title":"Get field values on a single Company","deprecated":null,"version":null,"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":"Perform batch operations on a company's fields","deprecated":null,"version":null,"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 a single field value on a Company","deprecated":null,"version":null,"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,"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":"Get values for a single field on a Company","deprecated":null,"version":null,"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"},{"title":"Get a Company's List Entries","deprecated":null,"version":null,"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,"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,"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,"openapi":"/schema/temp/publish.yml get /v2/companies/{companyId}/relationships","href":"/api-reference/2026-09-17/companies/get-relationships-for-a-company"}]},{"group":"Company Merges","pages":[{"title":"Get All Company Merges","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/company-merges","href":"/api-reference/2026-09-17/company-merges/get-all-company-merges"},{"title":"Initiate Company Merge","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/company-merges","href":"/api-reference/2026-09-17/company-merges/initiate-company-merge"},{"title":"Get Company Merge","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/company-merges/{mergeId}","href":"/api-reference/2026-09-17/company-merges/get-company-merge"},{"title":"Get All Company Merge Tasks","deprecated":null,"version":null,"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,"openapi":"/schema/temp/publish.yml get /v2/tasks/company-merges/{taskId}","href":"/api-reference/2026-09-17/company-merges/get-company-merge-task"}]},{"group":"Company Duplicate Suggestions","pages":[{"title":"Get All Company Duplicate Suggestions","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/duplicates/company-suggestions","href":"/api-reference/2026-09-17/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/publish.yml get /v2/duplicates/person-suggestions","href":"/api-reference/2026-09-17/person-duplicate-suggestions/get-all-person-duplicate-suggestions"}]},{"group":"Emails","pages":[{"title":"Get metadata on all Emails","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/emails","href":"/api-reference/2026-09-17/emails/get-metadata-on-all-emails"}]},{"group":"Feedback","pages":[{"title":"Send Feedback","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/feedback","href":"/api-reference/2026-09-17/feedback/send-feedback"}]},{"group":"Field Value Changes","pages":[{"title":"Get all field value changes","deprecated":null,"version":null,"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","pages":[{"title":"Get all Files","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/files","href":"/api-reference/2026-09-17/files/get-all-files"},{"title":"Search Files by Keyword","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/files/search","href":"/api-reference/2026-09-17/files/search-files-by-keyword"},{"title":"Get a single File","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/files/{fileId}","href":"/api-reference/2026-09-17/files/get-a-single-file"}]},{"group":"Inferred Connections","pages":[{"title":"Get Coworker Inferred Connections","deprecated":null,"version":null,"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,"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","pages":[{"title":"Get Introduction Paths","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/intro-paths","href":"/api-reference/2026-09-17/intro-paths/get-introduction-paths"}]},{"group":"Lists","pages":[{"title":"Get metadata on all Lists","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/lists","href":"/api-reference/2026-09-17/lists/get-metadata-on-all-lists"},{"title":"Create a List","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/lists","href":"/api-reference/2026-09-17/lists/create-a-list"},{"title":"Get metadata on a single List","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/lists/{listId}","href":"/api-reference/2026-09-17/lists/get-metadata-on-a-single-list"},{"title":"Get metadata on a single List's Fields","deprecated":null,"version":null,"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,"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":"Create a dropdown option for a List Field","deprecated":null,"version":null,"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":"Get a dropdown option for a List Field","deprecated":null,"version":null,"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":"Update a dropdown option for a List Field","deprecated":null,"version":null,"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,"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"},{"title":"Get all List Entries on a List","deprecated":null,"version":null,"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":"Add a List Entry to a List","deprecated":null,"version":null,"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":"Search List Entries","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/lists/{listId}/list-entries/search","href":"/api-reference/2026-09-17/lists/search-list-entries"},{"title":"Get a single List Entry on a List","deprecated":null,"version":null,"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":"Get Field Value Changes on a List Entry","deprecated":null,"version":null,"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"},{"title":"Get field values on a single List Entry","deprecated":null,"version":null,"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":"Perform batch operations on a list entry's fields","deprecated":null,"version":null,"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 a single field value","deprecated":null,"version":null,"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,"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":"Get values for a single field on a List Entry","deprecated":null,"version":null,"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"},{"title":"Get metadata on Saved Views","deprecated":null,"version":null,"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,"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,"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":"Meetings","pages":[{"title":"Get metadata on all Meetings","deprecated":null,"version":null,"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,"openapi":"/schema/temp/publish.yml get /v2/meetings/{meetingId}","href":"/api-reference/2026-09-17/meetings/get-a-single-meeting"}]},{"group":"Notes","pages":[{"title":"Get all Notes","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/notes","href":"/api-reference/2026-09-17/notes/get-all-notes"},{"title":"Create a Note","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/notes","href":"/api-reference/2026-09-17/notes/create-a-note"},{"title":"Search Notes by Keyword","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/notes/search","href":"/api-reference/2026-09-17/notes/search-notes-by-keyword"},{"title":"Get a single Note","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}","href":"/api-reference/2026-09-17/notes/get-a-single-note"},{"title":"Update a single Note","deprecated":null,"version":null,"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,"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,"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,"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,"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,"openapi":"/schema/temp/publish.yml get /v2/notes/{noteId}/replies","href":"/api-reference/2026-09-17/notes/get-replies-for-a-note"}]},{"group":"Opportunities","pages":[{"title":"Get all Opportunities","deprecated":null,"version":null,"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,"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,"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,"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,"openapi":"/schema/temp/publish.yml get /v2/opportunities/{opportunityId}/notes","href":"/api-reference/2026-09-17/opportunities/get-notes-for-an-opportunity"}]},{"group":"Person Merges","pages":[{"title":"Get All Person Merges","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/person-merges","href":"/api-reference/2026-09-17/person-merges/get-all-person-merges"},{"title":"Initiate Person Merge","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/person-merges","href":"/api-reference/2026-09-17/person-merges/initiate-person-merge"},{"title":"Get Person Merge","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/person-merges/{mergeId}","href":"/api-reference/2026-09-17/person-merges/get-person-merge"},{"title":"Get All Person Merge Tasks","deprecated":null,"version":null,"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,"openapi":"/schema/temp/publish.yml get /v2/tasks/person-merges/{taskId}","href":"/api-reference/2026-09-17/person-merges/get-person-merge-task"}]},{"group":"Persons","pages":[{"title":"Get all Persons","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/persons","href":"/api-reference/2026-09-17/persons/get-all-persons"},{"title":"Create a Person","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/persons","href":"/api-reference/2026-09-17/persons/create-a-person"},{"title":"Get metadata on Person Fields","deprecated":null,"version":null,"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,"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"},{"title":"Search Persons","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/persons/search","href":"/api-reference/2026-09-17/persons/search-persons"},{"title":"Get a single Person","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/persons/{personId}","href":"/api-reference/2026-09-17/persons/get-a-single-person"},{"title":"Delete a Person","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml delete /v2/persons/{personId}","href":"/api-reference/2026-09-17/persons/delete-a-person"},{"title":"Get field values on a single Person","deprecated":null,"version":null,"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":"Perform batch operations on a person's fields","deprecated":null,"version":null,"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 a single field on a Person","deprecated":null,"version":null,"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,"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":"Get values for a single field on a Person","deprecated":null,"version":null,"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"},{"title":"Get a Person's List Entries","deprecated":null,"version":null,"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,"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,"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,"openapi":"/schema/temp/publish.yml get /v2/persons/{personId}/relationships","href":"/api-reference/2026-09-17/persons/get-relationships-for-a-person"}]},{"group":"Rate Limit","pages":[{"title":"Get rate limit usage","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/rate-limit","href":"/api-reference/2026-09-17/rate-limit/get-rate-limit-usage"}]},{"group":"Reminders","pages":[{"title":"Get all Reminders","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/reminders","href":"/api-reference/2026-09-17/reminders/get-all-reminders"},{"title":"Create a Reminder","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/reminders","href":"/api-reference/2026-09-17/reminders/create-a-reminder"},{"title":"Get a single Reminder","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/reminders/{reminderId}","href":"/api-reference/2026-09-17/reminders/get-a-single-reminder"},{"title":"Update a Reminder","deprecated":null,"version":null,"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,"openapi":"/schema/temp/publish.yml delete /v2/reminders/{reminderId}","href":"/api-reference/2026-09-17/reminders/delete-a-reminder"}]},{"group":"Semantic Search","pages":[{"title":"Semantic Search","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/semantic-search","href":"/api-reference/2026-09-17/semantic-search/semantic-search"}]},{"group":"Teams","pages":[{"title":"Get metadata on all Teams","deprecated":null,"version":null,"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,"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,"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,"openapi":"/schema/temp/publish.yml get /v2/teams/{teamId}/members","href":"/api-reference/2026-09-17/teams/get-all-members-of-a-team"}]},{"group":"Transcripts","pages":[{"title":"Get all Transcripts","deprecated":null,"version":null,"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,"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,"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,"openapi":"/schema/temp/publish.yml get /v2/transcripts/{transcriptId}/fragments","href":"/api-reference/2026-09-17/transcripts/get-fragments-of-a-transcript"}]},{"group":"Users","pages":[{"title":"Get all Users","deprecated":null,"version":null,"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,"openapi":"/schema/temp/publish.yml get /v2/users/{userId}","href":"/api-reference/2026-09-17/users/get-a-single-user"}]},{"group":"Webhooks","pages":[{"title":"Get all Webhooks","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/webhooks","href":"/api-reference/2026-09-17/webhooks/get-all-webhooks"},{"title":"Create a Webhook","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml post /v2/webhooks","href":"/api-reference/2026-09-17/webhooks/create-a-webhook"},{"title":"Get a single Webhook","deprecated":null,"version":null,"openapi":"/schema/temp/publish.yml get /v2/webhooks/{webhookId}","href":"/api-reference/2026-09-17/webhooks/get-a-single-webhook"},{"title":"Update a Webhook","deprecated":null,"version":null,"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,"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","description":"Retrieve field value changes across all entities and fields in your Affinity workspace.\n\nFor an overview of field value changes, including which fields support change tracking and how the action types behave, see [Field Value Changes](/pages/data-model/working-with-field-data#field-value-changes).\n\nThis endpoint is built for delta-sync. Within a single sync, follow `pagination.nextUrl` to page through results until it becomes `null`, which means you have reached the most recent change. To run the next incremental sync, record the `changedAt` of the last change you processed and, on your next sync, filter for changes newer than that timestamp (for example, `filter=changedAt>2024-06-01T12:00:00Z`). Do not persist `nextUrl` between syncs, since it is `null` once you are caught up. Changes are returned in ascending order of `changedAt`, then by internal change ID. Only fields with change tracking enabled are included.\n\nYou can filter results using the `filter` query parameter.\n\n| **Property Name** | **Type** | **Description** | **Allowed Operators** | **Examples** |\n|---|---|---|---|---|\n| `field.id` | `text` | | `=` | `field.id=field-1234` |\n| `listEntry.id` | `int64` | | `=` | `listEntry.id=5678` |\n| `changer.id` | `int64` | The person who made the change. | `=` | `changer.id=9012` |\n| `changedAt` | `datetime` | When the change was made. | `>`, `\u003c`, `>=`, `\u003c=` | `changedAt>=2025-01-01T00:00:00Z` |\n| `actionType` | `text` | The type of change (`add`, `update`, `delete`) | `=` | `actionType=add` |\n\nFilters can be combined:\n- `|` (OR) to match any of multiple values: `field.id=field-1 | field.id=field-2`\n- `\u0026` (AND) to require all conditions: `changedAt>=2025-01-01T00:00:00Z \u0026 changedAt\u003c=2025-12-31T23:59:59Z`\n","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","description":"| ⚠️ This endpoint is currently in BETA |\n|--|\n\nReturns inferred connections based on shared work history, grouped by the target person, strongest first.\n\nA connection is the belief that a `source` (a person in your Affinity data, with an `id`, whom you know) might know a `target` (a person not in your Affinity data, described only, whom you want to know), because the two had overlapping employment at a shared company.\n\nThe same target can be reachable through several people you know. Connections are grouped by target: each item in `data` is one target together with the `connections` to them. Within a target, connections are ordered by `confidence` descending; targets are ordered by their strongest connection, strongest first.\n\nEach `target` carries the company they work at **today** in `target.currentCompany`: the company at which they are a potential contact now, which is not necessarily the shared employer behind the connection.\n\nThe `filter` parameter is required and must contain at least one filter. The only currently supported filter is `target.currentCompany.id`, which narrows the targets to a single such company.\n\n## Filters\n\n| **Property Name** | **Type** | **Description** | **Allowed Operators** | **Examples** |\n|---|---|---|---|---|\n| `target.currentCompany.id` | `integer` | The id of the company the `target` person currently works at. Must reference a single company; filtering on more than one (e.g. `target.currentCompany.id = 1 \\| target.currentCompany.id = 2`) returns a `400`. | `=` | `target.currentCompany.id = 123` |\n","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","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","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"}]}]},"title":"Search Files by Keyword - Affinity Developer Documentation","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}