--- title: "Preview" method: POST path: "/companies/similar/preview" tags: ["Company / Similar"] --- # Preview `POST /companies/similar/preview` ## Request - Base URL: `https://api.companyenrich.com` - URL: `https://api.companyenrich.com/companies/similar/preview` - Auth: API key in header `Authorization` **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. ## Query parameters - `waitForEnrichment` boolean ## Request body - CompanySimilarInput2 - `domains` string[]: The domains to find similar companies for. Up to 10 domains are allowed. - `similarityWeight` number, double: 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. - `minScore` number, double, nullable: The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used. - `exclude` CompanyExcludeFilters, nullable: Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results. - `domains` string[], nullable: The domain names of companies to exclude from the results - `regions` string[], nullable: The region IDs to filter by - `countries` string[], nullable: The 2 letter country codes to filter by - `states` integer[], nullable: The state IDs to filter by - `cities` integer[], nullable: The city IDs to filter by - `type` CompanyType[], nullable: The list of company types to filter by - `category` CompanyCategory[], nullable: The list of company categories to filter by - `employees` CompanyEmployees[], nullable: The list of employee counts to filter by - `reportedEmployees` CompanyEmployees[], nullable: The list of externally reported employee counts to filter by - `revenue` CompanyRevenue[], nullable: The list of revenue ranges to filter by - `naicsCode` integer[], nullable: 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` string[], nullable: The keywords to filter by - `technologies` string[], nullable: The technologies to filter by - `fundingRounds` CompanyFundingRound[], nullable: The funding rounds to filter by - `query` string, nullable: The search query to apply on the company name and domain - `foundedYear` YearRange, nullable: The range of years - `min` integer, nullable: The minimum year (inclusive) - `max` integer, nullable: The maximum year (inclusive) - `fundingAmount` CompanyFundingAmountRange, nullable: The funding amount range to filter by - `min` number, double, nullable: The minimum funding amount (inclusive) - `max` number, double, nullable: The maximum funding amount (inclusive) - `fundingYear` YearRange, nullable: The range of years - `min` integer, nullable: The minimum year (inclusive) - `max` integer, nullable: The maximum year (inclusive) - `categoryOperator` unknown - `keywordsOperator` unknown - `technologiesOperator` unknown - `workforceGrowth` CompanyWorkforceGrowthInput, nullable: Filter companies by workforce growth percentage over a selected period and department. - `period` unknown - `department` unknown - `minPercent` number, double, nullable: The minimum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline. - `maxPercent` number, double, nullable: The maximum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline. - `workforceSize` CompanyWorkforceSizeInput[], nullable: Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously. - `department` unknown - `min` integer, nullable: The minimum headcount (inclusive). - `max` integer, nullable: The maximum headcount (inclusive). - `require` FeatureRequirement[], nullable: The features that must exist for the company - `regions` string[], nullable: The region IDs to filter by - `countries` string[], nullable: The 2 letter country codes to filter by - `states` integer[], nullable: The state IDs to filter by - `cities` integer[], nullable: The city IDs to filter by - `type` CompanyType[], nullable: The list of company types to filter by - `category` CompanyCategory[], nullable: The list of company categories to filter by - `employees` CompanyEmployees[], nullable: The list of employee counts to filter by - `reportedEmployees` CompanyEmployees[], nullable: The list of externally reported employee counts to filter by - `revenue` CompanyRevenue[], nullable: The list of revenue ranges to filter by - `naicsCode` integer[], nullable: 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` string[], nullable: The keywords to filter by - `technologies` string[], nullable: The technologies to filter by - `fundingRounds` CompanyFundingRound[], nullable: The funding rounds to filter by ## Response `200` OK - PaginatedListWithMetadataOfCompanySummaryAndSimilarMetadata - `items` CompanySummary[], required: The items in the list - `id` string, uuid, required: The unique identifier of the company - `name` string, nullable: The name of the company - `domain` string, nullable: The primary domain name of the company - `website` string, uri, nullable: The website URL of the company - `industry` string, nullable: The main industry of the company - `description` string, nullable: The description of the company - `keywords` string[], nullable: The search keywords of the company - `logo_url` string, nullable: The logo URL of the company - `updated_at` string, date-time: The last updated timestamp of the company - `metadata` SimilarMetadata, nullable: The additional metadata for the list - `scores` object, required: 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. - `page` integer: The current page number. 1-indexed - `totalPages` integer: The total number of pages - `totalItems` integer: The total number of items in the list ## Other responses - `400`: Bad Request - `401`: Unauthorized - `402`: Payment Required - `404`: Not Found - `422`: Unprocessable Entity - `429`: Too Many Requests --- [API](https://skmtc.dev/companyenrich/apis/company-enrich-api.md) - [All operations](https://skmtc.dev/companyenrich/apis/company-enrich-api/llms.txt) - [OpenAPI document](https://skmtc.dev/companyenrich/apis/company-enrich-api/revisions/07f84debab87?raw)