Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more.
This endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.
Whether to wait for on-demand enrichment when a seed company is not stored yet. When false, valid missing domains are scheduled for background enrichment and the request returns a 404 if any seed company is missing, so it can be retried with a stable seed set later. This only controls seed-company enrichment; preparing a similarity vector for a stored company may still require processing.
The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CompanyEnrich","description":"Company and people intelligence for your applications, workflows, and AI agents.","colors":{"primary":"#076CD9","light":"#3B82F6","dark":"#076CD9"},"logo":{"light":"https://mintcdn.com/enricky/uFhw8wLexOtLvJhN/logo/light.svg?fit=max\u0026auto=format\u0026n=uFhw8wLexOtLvJhN\u0026q=85\u0026s=8e714beb05cf47ed874ca525159c48c5","dark":"https://mintcdn.com/enricky/uFhw8wLexOtLvJhN/logo/dark.svg?fit=max\u0026auto=format\u0026n=uFhw8wLexOtLvJhN\u0026q=85\u0026s=3aa35e72390bc6fe4330cc5d3e3ec0e4","href":"https://companyenrich.com"},"favicon":"https://mintcdn.com/enricky/uFhw8wLexOtLvJhN/favicon.ico?fit=max\u0026auto=format\u0026n=uFhw8wLexOtLvJhN\u0026q=85\u0026s=cb356b117f113c02098fff8fbb9ae78f","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","javascript","python"]}},"navbar":{"links":[{"href":"mailto:support@companyenrich.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.companyenrich.com"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"enricky","hasAudioNarration":false,"actualSubdomain":"enricky","customDomains":["docs.companyenrich.com"],"gitSource":{"type":"github","owner":"companyenrich","repo":"companyenrich-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6af469509abf89268db669d2"},"entitlements":{},"buildId":"6af5cf196c77b2e5c483c3cb","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API V1","count":49},{"language":"default","tag":"API V2","count":36},{"language":"default","tag":"Guides","count":34},{"language":"default","tag":"Company · Enrichment","count":11},{"language":"default","tag":"Geo","count":10},{"language":"default","tag":"Company · Search","count":8},{"language":"default","tag":"People · Search","count":7},{"language":"default","tag":"People · Enrichment","count":7},{"language":"default","tag":"SDKs, CLI \u0026 AI agents","count":6},{"language":"default","tag":"Company · Lists","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/v1/post-companies-similar-preview","slug":"/api-reference/v1/post-companies-similar-preview","pageMetadata":{"title":"Preview","openapi":"openapi/v1.json POST /companies/similar/preview","description":"**Cost:** FREE - No credits deducted\n\n**Requirements:** Requires **Scale** plans\n\n**Notice:** Returns top 25 results only\n\nPreview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more.\nThis endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.","href":"/api-reference/v1/post-companies-similar-preview"},"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 p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Cost:\"\n }), \" FREE - No credits deducted\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Requirements:\"\n }), \" Requires \", _jsx(_components.strong, {\n children: \"Scale\"\n }), \" plans\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Notice:\"\n }), \" Returns top 25 results only\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more.\\nThis endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.\"\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":"Preview","openapi":"openapi/v1.json POST /companies/similar/preview","description":"**Cost:** FREE - No credits deducted\n\n**Requirements:** Requires **Scale** plans\n\n**Notice:** Returns top 25 results only\n\nPreview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more.\nThis endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.","href":"/api-reference/v1/post-companies-similar-preview"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Company / Similar"],"summary":"Preview","description":"**Cost:** FREE - No credits deducted\n\n**Requirements:** Requires **Scale** plans\n\n**Notice:** Returns top 25 results only\n\nPreview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more.\nThis endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.","parameters":["0bce81cf-b18d-476d-9a69-48118d55a6ca"],"requestBody":"0368d2cc-b537-4595-b9ae-e9aeaa6d9f36","responses":{"200":"300e0bbd-af98-4156-b92e-0cdd96efd8da","400":"22ebca54-c973-4bdd-9e7d-a781aaae88ae","401":"29e60b60-1c15-4207-8892-17143d07822e","402":"0c5ef20c-a964-4669-9ec9-464e548e73ed","404":"5ed1bba5-7c2b-474e-b25c-62dee3ef7b08","422":"8c83b207-65ab-473d-98b1-a54c693ea961","429":"cd731c46-0b34-4a6c-89dd-a33ccaff77bb"},"method":"post","type":"path","servers":["7a4bd709-5baf-4342-9be0-844b63950e07"],"security":["55ee5a76-94d8-4bff-b801-799c1dba402c"],"path":"/companies/similar/preview","baseUrlOptions":["https://api.companyenrich.com"],"title":"Preview","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0bce81cf-b18d-476d-9a69-48118d55a6ca":{"name":"waitForEnrichment","in":"query","description":"Whether to wait for on-demand enrichment when a seed company is not stored yet. When false, valid missing domains are scheduled for background enrichment and the request returns a 404 if any seed company is missing, so it can be retried with a stable seed set later. This only controls seed-company enrichment; preparing a similarity vector for a stored company may still require processing.","schema":{"type":"boolean","default":true,"description":"Whether to wait for on-demand enrichment when a seed company is not stored yet. When false, valid missing domains are scheduled for background enrichment and the request returns a 404 if any seed company is missing, so it can be retried with a stable seed set later. This only controls seed-company enrichment; preparing a similarity vector for a stored company may still require processing.","uniqueKey":"","typeLabel":"boolean"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"domains":{"maxItems":10,"minItems":1,"type":"array","items":{"type":"string","uniqueKey":"domains.items.[INDEX]","typeLabel":"string"},"description":"The domains to find similar companies for. Up to 10 domains are allowed.","uniqueKey":"domains","typeLabel":"string[]"},"similarityWeight":{"maximum":1,"minimum":-1,"type":"number","description":"The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.","format":"double","uniqueKey":"similarityWeight","typeLabel":"number\u003cdouble>"},"minScore":{"oneOf":[{"maximum":1,"minimum":0,"type":"number","description":"The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.","format":"double","uniqueKey":"minScore.oneOf.0","typeLabel":"number\u003cdouble>"},{"maximum":1,"minimum":0,"type":"null","description":"The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.","format":"double","uniqueKey":"minScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"minScore","typeLabel":"number\u003cdouble> | null"},"exclude":{"oneOf":[{"type":"object","properties":{"domains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.0.domains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The domain names of companies to exclude from the results","uniqueKey":"exclude.oneOf.0.domains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The domain names of companies to exclude from the results","uniqueKey":"exclude.oneOf.0.domains.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.domains","typeLabel":"string[] | null"},"regions":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.0.regions.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The region IDs to filter by","uniqueKey":"exclude.oneOf.0.regions.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The region IDs to filter by","uniqueKey":"exclude.oneOf.0.regions.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.regions","typeLabel":"string[] | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.0.countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The 2 letter country codes to filter by","uniqueKey":"exclude.oneOf.0.countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The 2 letter country codes to filter by","uniqueKey":"exclude.oneOf.0.countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.countries","typeLabel":"string[] | null"},"states":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32","uniqueKey":"exclude.oneOf.0.states.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"The state IDs to filter by","uniqueKey":"exclude.oneOf.0.states.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The state IDs to filter by","uniqueKey":"exclude.oneOf.0.states.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.states","typeLabel":"integer\u003cint32>[] | null"},"cities":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32","uniqueKey":"exclude.oneOf.0.cities.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"The city IDs to filter by","uniqueKey":"exclude.oneOf.0.cities.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The city IDs to filter by","uniqueKey":"exclude.oneOf.0.cities.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.cities","typeLabel":"integer\u003cint32>[] | null"},"type":{"oneOf":[{"type":"array","items":{"enum":["private","public","self-employed","self-owned","partnership","nonprofit","educational","government"],"type":"string","uniqueKey":"exclude.oneOf.0.type.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of company types to filter by","uniqueKey":"exclude.oneOf.0.type.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["private","public","self-employed","self-owned","partnership","nonprofit","educational","government"],"type":"string"},"description":"The list of company types to filter by","uniqueKey":"exclude.oneOf.0.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.type","typeLabel":"enum\u003cstring>[] | null"},"category":{"oneOf":[{"type":"array","items":{"enum":["b2b","b2c","b2g","e-commerce","media","service-provider","mobile","saas","local-business"],"type":"string","uniqueKey":"exclude.oneOf.0.category.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of company categories to filter by","uniqueKey":"exclude.oneOf.0.category.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["b2b","b2c","b2g","e-commerce","media","service-provider","mobile","saas","local-business"],"type":"string"},"description":"The list of company categories to filter by","uniqueKey":"exclude.oneOf.0.category.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.category","typeLabel":"enum\u003cstring>[] | null"},"employees":{"oneOf":[{"type":"array","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string","uniqueKey":"exclude.oneOf.0.employees.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of employee counts to filter by","uniqueKey":"exclude.oneOf.0.employees.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of employee counts to filter by","uniqueKey":"exclude.oneOf.0.employees.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.employees","typeLabel":"enum\u003cstring>[] | null"},"reportedEmployees":{"oneOf":[{"type":"array","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string","uniqueKey":"exclude.oneOf.0.reportedEmployees.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of externally reported employee counts to filter by","uniqueKey":"exclude.oneOf.0.reportedEmployees.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of externally reported employee counts to filter by","uniqueKey":"exclude.oneOf.0.reportedEmployees.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.reportedEmployees","typeLabel":"enum\u003cstring>[] | null"},"revenue":{"oneOf":[{"type":"array","items":{"enum":["under-1m","1m-10m","10m-50m","50m-100m","100m-200m","200m-1b","over-1b"],"type":"string","uniqueKey":"exclude.oneOf.0.revenue.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of revenue ranges to filter by","uniqueKey":"exclude.oneOf.0.revenue.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["under-1m","1m-10m","10m-50m","50m-100m","100m-200m","200m-1b","over-1b"],"type":"string"},"description":"The list of revenue ranges to filter by","uniqueKey":"exclude.oneOf.0.revenue.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.revenue","typeLabel":"enum\u003cstring>[] | null"},"naicsCode":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32","uniqueKey":"exclude.oneOf.0.naicsCode.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included","uniqueKey":"exclude.oneOf.0.naicsCode.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included","uniqueKey":"exclude.oneOf.0.naicsCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.naicsCode","typeLabel":"integer\u003cint32>[] | null"},"keywords":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.0.keywords.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The keywords to filter by","uniqueKey":"exclude.oneOf.0.keywords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The keywords to filter by","uniqueKey":"exclude.oneOf.0.keywords.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.keywords","typeLabel":"string[] | null"},"technologies":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"exclude.oneOf.0.technologies.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The technologies to filter by","uniqueKey":"exclude.oneOf.0.technologies.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The technologies to filter by","uniqueKey":"exclude.oneOf.0.technologies.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.technologies","typeLabel":"string[] | null"},"fundingRounds":{"oneOf":[{"type":"array","items":{"enum":["seed","debt_financing","angel","venture","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","other"],"type":"string","uniqueKey":"exclude.oneOf.0.fundingRounds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The funding rounds to filter by","uniqueKey":"exclude.oneOf.0.fundingRounds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["seed","debt_financing","angel","venture","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","other"],"type":"string"},"description":"The funding rounds to filter by","uniqueKey":"exclude.oneOf.0.fundingRounds.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude.oneOf.0.fundingRounds","typeLabel":"enum\u003cstring>[] | null"}},"description":"Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.","uniqueKey":"exclude.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"domains":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"The domain names of companies to exclude from the results"},{"type":"null","items":{"type":"string"},"description":"The domain names of companies to exclude from the results"}]},"regions":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"The region IDs to filter by"},{"type":"null","items":{"type":"string"},"description":"The region IDs to filter by"}]},"countries":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"The 2 letter country codes to filter by"},{"type":"null","items":{"type":"string"},"description":"The 2 letter country codes to filter by"}]},"states":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32"},"description":"The state IDs to filter by"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The state IDs to filter by"}]},"cities":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32"},"description":"The city IDs to filter by"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The city IDs to filter by"}]},"type":{"oneOf":[{"type":"array","items":{"enum":["private","public","self-employed","self-owned","partnership","nonprofit","educational","government"],"type":"string"},"description":"The list of company types to filter by"},{"type":"null","items":{"enum":["private","public","self-employed","self-owned","partnership","nonprofit","educational","government"],"type":"string"},"description":"The list of company types to filter by"}]},"category":{"oneOf":[{"type":"array","items":{"enum":["b2b","b2c","b2g","e-commerce","media","service-provider","mobile","saas","local-business"],"type":"string"},"description":"The list of company categories to filter by"},{"type":"null","items":{"enum":["b2b","b2c","b2g","e-commerce","media","service-provider","mobile","saas","local-business"],"type":"string"},"description":"The list of company categories to filter by"}]},"employees":{"oneOf":[{"type":"array","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of employee counts to filter by"},{"type":"null","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of employee counts to filter by"}]},"reportedEmployees":{"oneOf":[{"type":"array","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of externally reported employee counts to filter by"},{"type":"null","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of externally reported employee counts to filter by"}]},"revenue":{"oneOf":[{"type":"array","items":{"enum":["under-1m","1m-10m","10m-50m","50m-100m","100m-200m","200m-1b","over-1b"],"type":"string"},"description":"The list of revenue ranges to filter by"},{"type":"null","items":{"enum":["under-1m","1m-10m","10m-50m","50m-100m","100m-200m","200m-1b","over-1b"],"type":"string"},"description":"The list of revenue ranges to filter by"}]},"naicsCode":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32"},"description":"The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included"}]},"keywords":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"The keywords to filter by"},{"type":"null","items":{"type":"string"},"description":"The keywords to filter by"}]},"technologies":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"The technologies to filter by"},{"type":"null","items":{"type":"string"},"description":"The technologies to filter by"}]},"fundingRounds":{"oneOf":[{"type":"array","items":{"enum":["seed","debt_financing","angel","venture","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","other"],"type":"string"},"description":"The funding rounds to filter by"},{"type":"null","items":{"enum":["seed","debt_financing","angel","venture","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","other"],"type":"string"},"description":"The funding rounds to filter by"}]}},"description":"Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.","uniqueKey":"exclude.oneOf.1","typeLabel":"null"}],"uniqueKey":"exclude","typeLabel":"object | null"},"query":{"oneOf":[{"maxLength":250,"type":"string","description":"The search query to apply on the company name and domain","uniqueKey":"query.oneOf.0","typeLabel":"string"},{"maxLength":250,"type":"null","description":"The search query to apply on the company name and domain","uniqueKey":"query.oneOf.1","typeLabel":"null"}],"uniqueKey":"query","typeLabel":"string | null"},"foundedYear":{"oneOf":[{"type":"object","properties":{"min":{"oneOf":[{"type":"integer","description":"The minimum year (inclusive)","format":"int32","uniqueKey":"foundedYear.oneOf.0.min.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The minimum year (inclusive)","format":"int32","uniqueKey":"foundedYear.oneOf.0.min.oneOf.1","typeLabel":"null"}],"uniqueKey":"foundedYear.oneOf.0.min","typeLabel":"integer\u003cint32> | null"},"max":{"oneOf":[{"type":"integer","description":"The maximum year (inclusive)","format":"int32","uniqueKey":"foundedYear.oneOf.0.max.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The maximum year (inclusive)","format":"int32","uniqueKey":"foundedYear.oneOf.0.max.oneOf.1","typeLabel":"null"}],"uniqueKey":"foundedYear.oneOf.0.max","typeLabel":"integer\u003cint32> | null"}},"description":"The range of years","uniqueKey":"foundedYear.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"min":{"oneOf":[{"type":"integer","description":"The minimum year (inclusive)","format":"int32"},{"type":"null","description":"The minimum year (inclusive)","format":"int32"}]},"max":{"oneOf":[{"type":"integer","description":"The maximum year (inclusive)","format":"int32"},{"type":"null","description":"The maximum year (inclusive)","format":"int32"}]}},"description":"The range of years","uniqueKey":"foundedYear.oneOf.1","typeLabel":"null"}],"uniqueKey":"foundedYear","typeLabel":"object | null"},"fundingAmount":{"oneOf":[{"type":"object","properties":{"min":{"oneOf":[{"type":"number","description":"The minimum funding amount (inclusive)","format":"double","uniqueKey":"fundingAmount.oneOf.0.min.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The minimum funding amount (inclusive)","format":"double","uniqueKey":"fundingAmount.oneOf.0.min.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingAmount.oneOf.0.min","typeLabel":"number\u003cdouble> | null"},"max":{"oneOf":[{"type":"number","description":"The maximum funding amount (inclusive)","format":"double","uniqueKey":"fundingAmount.oneOf.0.max.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The maximum funding amount (inclusive)","format":"double","uniqueKey":"fundingAmount.oneOf.0.max.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingAmount.oneOf.0.max","typeLabel":"number\u003cdouble> | null"}},"description":"The funding amount range to filter by","uniqueKey":"fundingAmount.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"min":{"oneOf":[{"type":"number","description":"The minimum funding amount (inclusive)","format":"double"},{"type":"null","description":"The minimum funding amount (inclusive)","format":"double"}]},"max":{"oneOf":[{"type":"number","description":"The maximum funding amount (inclusive)","format":"double"},{"type":"null","description":"The maximum funding amount (inclusive)","format":"double"}]}},"description":"The funding amount range to filter by","uniqueKey":"fundingAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingAmount","typeLabel":"object | null"},"fundingYear":{"oneOf":[{"type":"object","properties":{"min":{"oneOf":[{"type":"integer","description":"The minimum year (inclusive)","format":"int32","uniqueKey":"fundingYear.oneOf.0.min.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The minimum year (inclusive)","format":"int32","uniqueKey":"fundingYear.oneOf.0.min.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingYear.oneOf.0.min","typeLabel":"integer\u003cint32> | null"},"max":{"oneOf":[{"type":"integer","description":"The maximum year (inclusive)","format":"int32","uniqueKey":"fundingYear.oneOf.0.max.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The maximum year (inclusive)","format":"int32","uniqueKey":"fundingYear.oneOf.0.max.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingYear.oneOf.0.max","typeLabel":"integer\u003cint32> | null"}},"description":"The range of years","uniqueKey":"fundingYear.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"min":{"oneOf":[{"type":"integer","description":"The minimum year (inclusive)","format":"int32"},{"type":"null","description":"The minimum year (inclusive)","format":"int32"}]},"max":{"oneOf":[{"type":"integer","description":"The maximum year (inclusive)","format":"int32"},{"type":"null","description":"The maximum year (inclusive)","format":"int32"}]}},"description":"The range of years","uniqueKey":"fundingYear.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingYear","typeLabel":"object | null"},"categoryOperator":{"oneOf":[{"enum":["And","Or",null],"description":"The operator to apply to the filters. Defaults to And.","uniqueKey":"categoryOperator.oneOf.0","typeLabel":"any"},{"enum":["And","Or",null],"description":"The operator to apply to the filters. Defaults to And.","type":"null","uniqueKey":"categoryOperator.oneOf.1","typeLabel":"null"}],"uniqueKey":"categoryOperator","typeLabel":"any | null"},"keywordsOperator":{"oneOf":[{"enum":["And","Or",null],"description":"The operator to apply to the filters. Defaults to And.","uniqueKey":"keywordsOperator.oneOf.0","typeLabel":"any"},{"enum":["And","Or",null],"description":"The operator to apply to the filters. Defaults to And.","type":"null","uniqueKey":"keywordsOperator.oneOf.1","typeLabel":"null"}],"uniqueKey":"keywordsOperator","typeLabel":"any | null"},"technologiesOperator":{"oneOf":[{"enum":["And","Or",null],"description":"The operator to apply to the filters. Defaults to And.","uniqueKey":"technologiesOperator.oneOf.0","typeLabel":"any"},{"enum":["And","Or",null],"description":"The operator to apply to the filters. Defaults to And.","type":"null","uniqueKey":"technologiesOperator.oneOf.1","typeLabel":"null"}],"uniqueKey":"technologiesOperator","typeLabel":"any | null"},"workforceGrowth":{"oneOf":[{"type":"object","properties":{"period":{"oneOf":[{"enum":["m6","y1","y2",null],"description":"The period to measure workforce growth over.","uniqueKey":"workforceGrowth.oneOf.0.period.oneOf.0","typeLabel":"any"},{"enum":["m6","y1","y2",null],"description":"The period to measure workforce growth over.","type":"null","uniqueKey":"workforceGrowth.oneOf.0.period.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceGrowth.oneOf.0.period","typeLabel":"any | null"},"department":{"oneOf":[{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to measure workforce growth for.","uniqueKey":"workforceGrowth.oneOf.0.department.oneOf.0","typeLabel":"any"},{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to measure workforce growth for.","type":"null","uniqueKey":"workforceGrowth.oneOf.0.department.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceGrowth.oneOf.0.department","typeLabel":"any | null"},"minPercent":{"oneOf":[{"type":"number","description":"The minimum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double","uniqueKey":"workforceGrowth.oneOf.0.minPercent.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The minimum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double","uniqueKey":"workforceGrowth.oneOf.0.minPercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceGrowth.oneOf.0.minPercent","typeLabel":"number\u003cdouble> | null"},"maxPercent":{"oneOf":[{"type":"number","description":"The maximum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double","uniqueKey":"workforceGrowth.oneOf.0.maxPercent.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The maximum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double","uniqueKey":"workforceGrowth.oneOf.0.maxPercent.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceGrowth.oneOf.0.maxPercent","typeLabel":"number\u003cdouble> | null"}},"description":"Filter companies by workforce growth percentage over a selected period and department.","uniqueKey":"workforceGrowth.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"period":{"oneOf":[{"enum":["m6","y1","y2",null],"description":"The period to measure workforce growth over."},{"enum":["m6","y1","y2",null],"description":"The period to measure workforce growth over.","type":"null"}]},"department":{"oneOf":[{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to measure workforce growth for."},{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to measure workforce growth for.","type":"null"}]},"minPercent":{"oneOf":[{"type":"number","description":"The minimum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double"},{"type":"null","description":"The minimum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double"}]},"maxPercent":{"oneOf":[{"type":"number","description":"The maximum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double"},{"type":"null","description":"The maximum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.","format":"double"}]}},"description":"Filter companies by workforce growth percentage over a selected period and department.","uniqueKey":"workforceGrowth.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceGrowth","typeLabel":"object | null"},"workforceSize":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"department":{"oneOf":[{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to filter headcount for. Defaults to overall if not specified.","uniqueKey":"workforceSize.oneOf.0.items.[INDEX].department.oneOf.0","typeLabel":"any"},{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to filter headcount for. Defaults to overall if not specified.","type":"null","uniqueKey":"workforceSize.oneOf.0.items.[INDEX].department.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceSize.oneOf.0.items.[INDEX].department","typeLabel":"any | null"},"min":{"oneOf":[{"type":"integer","description":"The minimum headcount (inclusive).","format":"int32","uniqueKey":"workforceSize.oneOf.0.items.[INDEX].min.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The minimum headcount (inclusive).","format":"int32","uniqueKey":"workforceSize.oneOf.0.items.[INDEX].min.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceSize.oneOf.0.items.[INDEX].min","typeLabel":"integer\u003cint32> | null"},"max":{"oneOf":[{"type":"integer","description":"The maximum headcount (inclusive).","format":"int32","uniqueKey":"workforceSize.oneOf.0.items.[INDEX].max.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The maximum headcount (inclusive).","format":"int32","uniqueKey":"workforceSize.oneOf.0.items.[INDEX].max.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceSize.oneOf.0.items.[INDEX].max","typeLabel":"integer\u003cint32> | null"}},"uniqueKey":"workforceSize.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.","uniqueKey":"workforceSize.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"department":{"oneOf":[{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to filter headcount for. Defaults to overall if not specified."},{"enum":["overall","c_suite","product_management","engineering_technical","design","education","finance","human_resources","information_technology","legal","marketing","medical_health","operations","sales","consulting",null],"description":"The department to filter headcount for. Defaults to overall if not specified.","type":"null"}]},"min":{"oneOf":[{"type":"integer","description":"The minimum headcount (inclusive).","format":"int32"},{"type":"null","description":"The minimum headcount (inclusive).","format":"int32"}]},"max":{"oneOf":[{"type":"integer","description":"The maximum headcount (inclusive).","format":"int32"},{"type":"null","description":"The maximum headcount (inclusive).","format":"int32"}]}}},"description":"Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.","uniqueKey":"workforceSize.oneOf.1","typeLabel":"null"}],"uniqueKey":"workforceSize","typeLabel":"object[] | null"},"require":{"oneOf":[{"type":"array","items":{"enum":["linkedin","twitter","facebook","instagram","angellist","crunchbase","youtube","country","city","state","revenue","foundedYear","anyFunding"],"type":"string","uniqueKey":"require.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The features that must exist for the company","uniqueKey":"require.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["linkedin","twitter","facebook","instagram","angellist","crunchbase","youtube","country","city","state","revenue","foundedYear","anyFunding"],"type":"string"},"description":"The features that must exist for the company","uniqueKey":"require.oneOf.1","typeLabel":"null"}],"uniqueKey":"require","typeLabel":"enum\u003cstring>[] | null"},"regions":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"regions.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The region IDs to filter by","uniqueKey":"regions.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The region IDs to filter by","uniqueKey":"regions.oneOf.1","typeLabel":"null"}],"uniqueKey":"regions","typeLabel":"string[] | null"},"countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The 2 letter country codes to filter by","uniqueKey":"countries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The 2 letter country codes to filter by","uniqueKey":"countries.oneOf.1","typeLabel":"null"}],"uniqueKey":"countries","typeLabel":"string[] | null"},"states":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32","uniqueKey":"states.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"The state IDs to filter by","uniqueKey":"states.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The state IDs to filter by","uniqueKey":"states.oneOf.1","typeLabel":"null"}],"uniqueKey":"states","typeLabel":"integer\u003cint32>[] | null"},"cities":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32","uniqueKey":"cities.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"The city IDs to filter by","uniqueKey":"cities.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The city IDs to filter by","uniqueKey":"cities.oneOf.1","typeLabel":"null"}],"uniqueKey":"cities","typeLabel":"integer\u003cint32>[] | null"},"type":{"oneOf":[{"type":"array","items":{"enum":["private","public","self-employed","self-owned","partnership","nonprofit","educational","government"],"type":"string","uniqueKey":"type.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of company types to filter by","uniqueKey":"type.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["private","public","self-employed","self-owned","partnership","nonprofit","educational","government"],"type":"string"},"description":"The list of company types to filter by","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"enum\u003cstring>[] | null"},"category":{"oneOf":[{"type":"array","items":{"enum":["b2b","b2c","b2g","e-commerce","media","service-provider","mobile","saas","local-business"],"type":"string","uniqueKey":"category.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of company categories to filter by","uniqueKey":"category.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["b2b","b2c","b2g","e-commerce","media","service-provider","mobile","saas","local-business"],"type":"string"},"description":"The list of company categories to filter by","uniqueKey":"category.oneOf.1","typeLabel":"null"}],"uniqueKey":"category","typeLabel":"enum\u003cstring>[] | null"},"employees":{"oneOf":[{"type":"array","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string","uniqueKey":"employees.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of employee counts to filter by","uniqueKey":"employees.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of employee counts to filter by","uniqueKey":"employees.oneOf.1","typeLabel":"null"}],"uniqueKey":"employees","typeLabel":"enum\u003cstring>[] | null"},"reportedEmployees":{"oneOf":[{"type":"array","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string","uniqueKey":"reportedEmployees.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of externally reported employee counts to filter by","uniqueKey":"reportedEmployees.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["1-10","11-50","51-200","201-500","501-1K","1K-5K","5K-10K","over-10K"],"type":"string"},"description":"The list of externally reported employee counts to filter by","uniqueKey":"reportedEmployees.oneOf.1","typeLabel":"null"}],"uniqueKey":"reportedEmployees","typeLabel":"enum\u003cstring>[] | null"},"revenue":{"oneOf":[{"type":"array","items":{"enum":["under-1m","1m-10m","10m-50m","50m-100m","100m-200m","200m-1b","over-1b"],"type":"string","uniqueKey":"revenue.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The list of revenue ranges to filter by","uniqueKey":"revenue.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["under-1m","1m-10m","10m-50m","50m-100m","100m-200m","200m-1b","over-1b"],"type":"string"},"description":"The list of revenue ranges to filter by","uniqueKey":"revenue.oneOf.1","typeLabel":"null"}],"uniqueKey":"revenue","typeLabel":"enum\u003cstring>[] | null"},"naicsCode":{"oneOf":[{"type":"array","items":{"type":"integer","format":"int32","uniqueKey":"naicsCode.oneOf.0.items.[INDEX]","typeLabel":"integer\u003cint32>"},"description":"The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included","uniqueKey":"naicsCode.oneOf.0","typeLabel":"integer\u003cint32>[]"},{"type":"null","items":{"type":"integer","format":"int32"},"description":"The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included","uniqueKey":"naicsCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"naicsCode","typeLabel":"integer\u003cint32>[] | null"},"keywords":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"keywords.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The keywords to filter by","uniqueKey":"keywords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The keywords to filter by","uniqueKey":"keywords.oneOf.1","typeLabel":"null"}],"uniqueKey":"keywords","typeLabel":"string[] | null"},"technologies":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"technologies.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The technologies to filter by","uniqueKey":"technologies.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The technologies to filter by","uniqueKey":"technologies.oneOf.1","typeLabel":"null"}],"uniqueKey":"technologies","typeLabel":"string[] | null"},"fundingRounds":{"oneOf":[{"type":"array","items":{"enum":["seed","debt_financing","angel","venture","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","other"],"type":"string","uniqueKey":"fundingRounds.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"The funding rounds to filter by","uniqueKey":"fundingRounds.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"enum":["seed","debt_financing","angel","venture","series_a","series_b","series_c","series_d","series_e","series_f","series_g","series_h","other"],"type":"string"},"description":"The funding rounds to filter by","uniqueKey":"fundingRounds.oneOf.1","typeLabel":"null"}],"uniqueKey":"fundingRounds","typeLabel":"enum\u003cstring>[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"domains":["\u003cstring>"],"similarityWeight":0,"minScore":0.5,"exclude":{"domains":["\u003cstring>"],"regions":["\u003cstring>"],"countries":["\u003cstring>"],"states":[123],"cities":[123],"type":[],"category":[],"employees":[],"reportedEmployees":[],"revenue":[],"naicsCode":[123],"keywords":["\u003cstring>"],"technologies":["\u003cstring>"],"fundingRounds":[]},"query":"\u003cstring>","foundedYear":{"min":123,"max":123},"fundingAmount":{"min":123,"max":123},"fundingYear":{"min":123,"max":123},"workforceGrowth":{"minPercent":123,"maxPercent":123},"workforceSize":[{"min":123,"max":123}],"require":[],"regions":["\u003cstring>"],"countries":["\u003cstring>"],"states":[123],"cities":[123],"type":[],"category":[],"employees":[],"reportedEmployees":[],"revenue":[],"naicsCode":[123],"keywords":["\u003cstring>"],"technologies":["\u003cstring>"],"fundingRounds":[]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"300e0bbd-af98-4156-b92e-0cdd96efd8da":{"description":"OK","content":{"application/json":{"schema":{"required":["items"],"type":"object","properties":{"items":{"type":"array","items":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the company","format":"uuid","isRequired":true,"uniqueKey":"\\items.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"oneOf":[{"maxLength":1024,"type":"string","description":"The name of the company","uniqueKey":"\\items.items.[INDEX].name.oneOf.0","typeLabel":"string"},{"maxLength":1024,"type":"null","description":"The name of the company","uniqueKey":"\\items.items.[INDEX].name.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].name","typeLabel":"string | null"},"domain":{"oneOf":[{"maxLength":1024,"type":"string","description":"The primary domain name of the company","uniqueKey":"\\items.items.[INDEX].domain.oneOf.0","typeLabel":"string"},{"maxLength":1024,"type":"null","description":"The primary domain name of the company","uniqueKey":"\\items.items.[INDEX].domain.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].domain","typeLabel":"string | null"},"website":{"oneOf":[{"type":"string","description":"The website URL of the company","format":"uri","uniqueKey":"\\items.items.[INDEX].website.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","description":"The website URL of the company","format":"uri","uniqueKey":"\\items.items.[INDEX].website.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].website","typeLabel":"string\u003curi> | null"},"industry":{"oneOf":[{"type":"string","description":"The main industry of the company","uniqueKey":"\\items.items.[INDEX].industry.oneOf.0","typeLabel":"string"},{"type":"null","description":"The main industry of the company","uniqueKey":"\\items.items.[INDEX].industry.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].industry","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"The description of the company","uniqueKey":"\\items.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"The description of the company","uniqueKey":"\\items.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string | null"},"keywords":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"\\items.items.[INDEX].keywords.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The search keywords of the company","uniqueKey":"\\items.items.[INDEX].keywords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The search keywords of the company","uniqueKey":"\\items.items.[INDEX].keywords.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].keywords","typeLabel":"string[] | null"},"logo_url":{"oneOf":[{"type":"string","description":"The logo URL of the company","uniqueKey":"\\items.items.[INDEX].logo_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The logo URL of the company","uniqueKey":"\\items.items.[INDEX].logo_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"\\items.items.[INDEX].logo_url","typeLabel":"string | null"},"updated_at":{"type":"string","description":"The last updated timestamp of the company","format":"date-time","uniqueKey":"\\items.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"description":"The items in the list","isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"metadata":{"oneOf":[{"required":["scores"],"type":"object","properties":{"scores":{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"metadata.oneOf.0.scores.additionalProperties","typeLabel":"number\u003cdouble>"},"description":"The ranking score for each company mapped by id. Higher values rank first. The scale depends on the similarity weight; scores may exceed 1 and are not probabilities.","isRequired":true,"uniqueKey":"metadata.oneOf.0.scores","typeLabel":"object"}},"description":"The additional metadata for the list","uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"required":["scores"],"type":"null","properties":{"scores":{"type":"object","additionalProperties":{"type":"number","format":"double"},"description":"The ranking score for each company mapped by id. Higher values rank first. The scale depends on the similarity weight; scores may exceed 1 and are not probabilities."}},"description":"The additional metadata for the list","uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"page":{"type":"integer","description":"The current page number. 1-indexed","format":"int32","uniqueKey":"page","typeLabel":"integer\u003cint32>"},"totalPages":{"type":"integer","description":"The total number of pages","format":"int32","uniqueKey":"totalPages","typeLabel":"integer\u003cint32>"},"totalItems":{"type":"integer","description":"The total number of items in the list","format":"int32","uniqueKey":"totalItems","typeLabel":"integer\u003cint32>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"items":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","domain":"\u003cstring>","website":"\u003cstring>","industry":"\u003cstring>","description":"\u003cstring>","keywords":["\u003cstring>"],"logo_url":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z"}],"metadata":{"scores":{}},"page":123,"totalPages":123,"totalItems":123}}},"exampleType":"generated"}},"exampleType":"generated"},"22ebca54-c973-4bdd-9e7d-a781aaae88ae":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"29e60b60-1c15-4207-8892-17143d07822e":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"0c5ef20c-a964-4669-9ec9-464e548e73ed":{"description":"Payment Required","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5ed1bba5-7c2b-474e-b25c-62dee3ef7b08":{"description":"Not Found","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"8c83b207-65ab-473d-98b1-a54c693ea961":{"description":"Unprocessable Entity","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"cd731c46-0b34-4a6c-89dd-a33ccaff77bb":{"description":"Too Many Requests","content":{"application/problem+json":{"schema":{"type":"object","properties":{"type":{"oneOf":[{"type":"string","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"status":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"status.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"status.oneOf.1","typeLabel":"null"}],"uniqueKey":"status","typeLabel":"integer\u003cint32> | null"},"detail":{"oneOf":[{"type":"string","uniqueKey":"detail.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail","typeLabel":"string | null"},"instance":{"oneOf":[{"type":"string","uniqueKey":"instance.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"instance.oneOf.1","typeLabel":"null"}],"uniqueKey":"instance","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"type":"\u003cstring>","title":"\u003cstring>","status":123,"detail":"\u003cstring>","instance":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"55ee5a76-94d8-4bff-b801-799c1dba402c":{"Bearer":{"type":"apiKey","description":"API Token used for authentication. Example: \"Authorization: Bearer {token}\"","name":"Authorization","in":"header","x-bearer-format":"bearer","scopes":[],"schemeName":"Bearer"}}},"servers":{"7a4bd709-5baf-4342-9be0-844b63950e07":{"url":"https://api.companyenrich.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"API Token used for authentication. Example: \"Authorization: Bearer {token}\"","name":"Authorization","in":"header","x-bearer-format":"bearer","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Authorization","type":"string","description":"API Token used for authentication. Example: \"Authorization: Bearer {token}\"","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi/v1.json"},"subdomain":"enricky","siteName":"CompanyEnrich","title":"Preview - CompanyEnrich","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T13:12:16.697Z","originalFileLocation":"api-reference/v1/post-companies-similar-preview.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=\"Cost: FREE - No credits deducted Requirements: Requires Scale plans Notice: Returns top 25 results only Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more. This endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.\">\u003cmeta data-mint-head name=\"application-name\" content=\"CompanyEnrich\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_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/enricky/nV4Cv7_70M1dM0oI/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview - CompanyEnrich\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cost: FREE - No credits deducted Requirements: Requires Scale plans Notice: Returns top 25 results only Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more. This endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CompanyEnrich\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://enricky.mintlify.site/_mintlify/api/og/v2?division=Company+%C2%B7+Similar\u0026amp;title=Preview\u0026amp;description=**Cost%3A**+FREE+-+No+credits+deducted%0A%0A**Requirements%3A**+Requires+**Scale**+plans%0A%0A**Notice%3A**+Returns+top+25+results+only%0A%0APreview+search+for+similar+companies+\u0026amp;theme=4b3a6da69f9bd8bbebb5003a\u0026amp;signature=5a355d754d17eda9e114c95985f79a118d57b6deb25b46b42dc059616dccb545\">\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=\"Preview - CompanyEnrich\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cost: FREE - No credits deducted Requirements: Requires Scale plans Notice: Returns top 25 results only Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more. This endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://enricky.mintlify.site/_mintlify/api/og/v2?division=Company+%C2%B7+Similar\u0026amp;title=Preview\u0026amp;description=**Cost%3A**+FREE+-+No+credits+deducted%0A%0A**Requirements%3A**+Requires+**Scale**+plans%0A%0A**Notice%3A**+Returns+top+25+results+only%0A%0APreview+search+for+similar+companies+\u0026amp;theme=4b3a6da69f9bd8bbebb5003a\u0026amp;signature=5a355d754d17eda9e114c95985f79a118d57b6deb25b46b42dc059616dccb545\">\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/enricky/nV4Cv7_70M1dM0oI/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CompanyEnrich\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#076CD9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v1/post-companies-similar-preview.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.companyenrich.com/#organization\",\"name\":\"CompanyEnrich\",\"url\":\"https://docs.companyenrich.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/enricky/uFhw8wLexOtLvJhN/logo/light.svg?fit=max\u0026auto=format\u0026n=uFhw8wLexOtLvJhN\u0026q=85\u0026s=8e714beb05cf47ed874ca525159c48c5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.companyenrich.com#website\",\"name\":\"CompanyEnrich\",\"url\":\"https://docs.companyenrich.com\",\"publisher\":{\"@id\":\"https://docs.companyenrich.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview#webpage\",\"url\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview\",\"name\":\"Preview\",\"description\":\"Cost: FREE - No credits deducted Requirements: Requires Scale plans Notice: Returns top 25 results only Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more. This endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.\",\"dateModified\":\"2026-11-11T13:12:16.697Z\",\"isPartOf\":{\"@id\":\"https://docs.companyenrich.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Company · Similar\",\"item\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Preview\",\"item\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview#apireference\",\"headline\":\"Preview\",\"name\":\"Preview\",\"description\":\"Cost: FREE - No credits deducted Requirements: Requires Scale plans Notice: Returns top 25 results only Preview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more. This endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.\",\"url\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview\",\"mainEntityOfPage\":{\"@id\":\"https://docs.companyenrich.com/api-reference/v1/post-companies-similar-preview#webpage\"},\"dateModified\":\"2026-11-11T13:12:16.697Z\",\"publisher\":{\"@id\":\"https://docs.companyenrich.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.companyenrich.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"CompanyEnrich\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"CompanyEnrich\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v1/post-companies-similar-preview.md","siteName":"CompanyEnrich","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/getting-started"}]},{"tab":"API V2","pages":[{"title":"API V2","href":"/api-reference/v2/overview"}]},{"tab":"API V1","groups":[{"group":"Overview","pages":[{"title":"API V1","href":"/api-reference/v1/overview"}]},{"group":"Company · Enrichment","pages":[{"title":"Enrich by domain","openapi":"openapi/v1.json GET /companies/enrich","href":"/api-reference/v1/get-companies-enrich"},{"title":"Enrich by properties","openapi":"openapi/v1.json POST /companies/enrich","href":"/api-reference/v1/post-companies-enrich"},{"title":"Batch enrich","openapi":"openapi/v1.json POST /companies/enrich/batch","href":"/api-reference/v1/post-companies-enrich-batch"},{"title":"Workforce","openapi":"openapi/v1.json GET /companies/workforce","href":"/api-reference/v1/get-companies-workforce"},{"title":"Autocomplete","openapi":"openapi/v1.json GET /companies/autocomplete","href":"/api-reference/v1/get-companies-autocomplete"}]},{"group":"Company · Bulk Enrichment","pages":[{"title":"Create job","openapi":"openapi/v1.json POST /companies/enrich/bulk","href":"/api-reference/v1/post-companies-enrich-bulk"},{"title":"Get job status","openapi":"openapi/v1.json GET /companies/enrich/bulk/{jobId}","href":"/api-reference/v1/get-companies-enrich-bulk-jobid"},{"title":"List jobs","openapi":"openapi/v1.json GET /companies/enrich/bulk/jobs","href":"/api-reference/v1/get-companies-enrich-bulk-jobs"}]},{"group":"Company · Search","pages":[{"title":"Search","openapi":"openapi/v1.json POST /companies/search","href":"/api-reference/v1/post-companies-search"},{"title":"Preview","openapi":"openapi/v1.json POST /companies/search/preview","href":"/api-reference/v1/post-companies-search-preview"},{"title":"Count","openapi":"openapi/v1.json POST /companies/search/count","href":"/api-reference/v1/post-companies-search-count"},{"title":"Scroll","openapi":"openapi/v1.json POST /companies/search/scroll","href":"/api-reference/v1/post-companies-search-scroll"},{"title":"Get by ID","openapi":"openapi/v1.json GET /companies","href":"/api-reference/v1/get-companies"}]},{"group":"Company · Export","pages":[{"title":"Create export job","openapi":"openapi/v1.json POST /companies/search/async","href":"/api-reference/v1/post-companies-search-async"},{"title":"Get export job status","openapi":"openapi/v1.json GET /companies/search/async/{jobId}","href":"/api-reference/v1/get-companies-search-async-jobid"},{"title":"List export jobs","openapi":"openapi/v1.json GET /companies/search/async/jobs","href":"/api-reference/v1/get-companies-search-async-jobs"}]},{"group":"Company · Similar","pages":[{"title":"Find similar","openapi":"openapi/v1.json POST /companies/similar","description":"**Cost:** 5 credit per company returned. 5 credits if no results are found.\n\nFinds similar companies to the given company by id or domain. The POST route allows specifying further filtering parameters.\nAt most 100 companies are returned per request.","href":"/api-reference/v1/post-companies-similar"},{"title":"Preview","openapi":"openapi/v1.json POST /companies/similar/preview","href":"/api-reference/v1/post-companies-similar-preview"},{"title":"Count","openapi":"openapi/v1.json POST /companies/similar/count","description":"**Cost:** FREE - No credits deducted\n\nReturns the total count of similar companies matching the given search criteria without retrieving the actual results.","href":"/api-reference/v1/post-companies-similar-count"},{"title":"Scroll","openapi":"openapi/v1.json POST /companies/similar/scroll","href":"/api-reference/v1/post-companies-similar-scroll"}]},{"group":"Industries","pages":[{"title":"List industries","openapi":"openapi/v1.json GET /industries","href":"/api-reference/v1/get-industries"}]},{"group":"Keywords","pages":[{"title":"Lookup keywords","openapi":"openapi/v1.json GET /keywords/autocomplete","href":"/api-reference/v1/get-keywords-autocomplete"}]},{"group":"Technologies","pages":[{"title":"Lookup technologies","openapi":"openapi/v1.json GET /technologies/autocomplete","href":"/api-reference/v1/get-technologies-autocomplete"}]},{"group":"Positions","pages":[{"title":"Lookup positions","openapi":"openapi/v1.json GET /positions/autocomplete","href":"/api-reference/v1/get-positions-autocomplete"}]},{"group":"User","pages":[{"title":"Get current user information","openapi":"openapi/v1.json GET /me","href":"/api-reference/v1/get-me"}]},{"group":"Jobs","pages":[{"title":"List all jobs","openapi":"openapi/v1.json GET /jobs","href":"/api-reference/v1/get-jobs"},{"title":"Get job details","openapi":"openapi/v1.json GET /jobs/{jobId}","href":"/api-reference/v1/get-jobs-jobid"}]},{"group":"Company · Lists","pages":[{"title":"Get all lists","openapi":"openapi/v1.json GET /lists/companies","href":"/api-reference/v1/get-lists-companies"},{"title":"Create list","openapi":"openapi/v1.json POST /lists/companies","href":"/api-reference/v1/post-lists-companies"},{"title":"Get a list by id","openapi":"openapi/v1.json GET /lists/companies/{id}","href":"/api-reference/v1/get-lists-companies-id"},{"title":"Update list","openapi":"openapi/v1.json PUT /lists/companies/{id}","href":"/api-reference/v1/put-lists-companies-id"},{"title":"Delete list","openapi":"openapi/v1.json DELETE /lists/companies/{id}","href":"/api-reference/v1/delete-lists-companies-id"}]},{"group":"People · Search","pages":[{"title":"Lookup person","openapi":"openapi/v1.json POST /people/lookup","href":"/api-reference/v1/post-people-lookup"},{"title":"Get by ID","openapi":"openapi/v1.json GET /people","href":"/api-reference/v1/get-people"},{"title":"Search","openapi":"openapi/v1.json POST /people/search","href":"/api-reference/v1/post-people-search"},{"title":"Scroll","openapi":"openapi/v1.json POST /people/search/scroll","href":"/api-reference/v1/post-people-search-scroll"}]},{"group":"People · Enrichment","pages":[{"title":"Email","openapi":"openapi/v1.json GET /people/email","href":"/api-reference/v1/get-people-email"},{"title":"Create bulk email enrichment job","openapi":"openapi/v1.json POST /people/email/bulk","href":"/api-reference/v1/post-people-email-bulk"},{"title":"Get bulk email enrichment job status","openapi":"openapi/v1.json GET /people/email/bulk/{jobId}","href":"/api-reference/v1/get-people-email-bulk-jobid"},{"title":"Education","openapi":"openapi/v1.json GET /people/education","href":"/api-reference/v1/get-people-education"}]},{"group":"People · Export","pages":[{"title":"Create export job","openapi":"openapi/v1.json POST /people/search/async","href":"/api-reference/v1/post-people-search-async"},{"title":"Get export job status","openapi":"openapi/v1.json GET /people/search/async/{jobId}","href":"/api-reference/v1/get-people-search-async-jobid"},{"title":"List export jobs","openapi":"openapi/v1.json GET /people/search/async/jobs","href":"/api-reference/v1/get-people-search-async-jobs"}]},{"group":"Geo","pages":[{"title":"Get regions","openapi":"openapi/v1.json GET /geo/regions","href":"/api-reference/v1/get-geo-regions"},{"title":"Get country by code","openapi":"openapi/v1.json GET /geo/countries/{countryCode}","href":"/api-reference/v1/get-geo-countries-countrycode"},{"title":"Search countries","openapi":"openapi/v1.json POST /geo/countries","href":"/api-reference/v1/post-geo-countries"},{"title":"Search states","openapi":"openapi/v1.json POST /geo/states","href":"/api-reference/v1/post-geo-states"},{"title":"Search cities","openapi":"openapi/v1.json POST /geo/cities","href":"/api-reference/v1/post-geo-cities"}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Preview - CompanyEnrich","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}