Skip to main content
CompanyEnrich logo
  • Category: company data
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 48
  • Triggers: 0
  • Slug: COMPANYENRICH
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: COMPANYENRICH_AUTOCOMPLETE_COMPANIESReturns a list of companies matching the given partial domain name. This is useful for autocompleting domain names in your application. Up to 10 companies are returned per request. Free; no charge. Use when you need to autocomplete company domains in your application.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

string
required
The domain name to autocomplete (e.g., ‘google’, ‘stripe’, ‘amazon’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_AUTOCOMPLETE_KEYWORDSLookup keywords for use in company search filters. This endpoint returns a list of keywords that match the provided query string. Use this action to discover valid keyword values before using them in company search filters. The results are sorted by relevance. Example: query=“tech” might return [“Technology”, “Tech”, “Information Technology”, …]Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

string
required
The search query for keywords. Use this to find matching keywords for company search filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_AUTOCOMPLETE_POSITIONSLookup positions/job titles for use in people search filters. This endpoint returns a list of job titles that match the provided query string. Use this action to discover valid position values before using them in people search filters. The results are sorted by relevance. Example: query=“engineer” might return [“Software Engineer”, “Data Engineer”, “Sales Engineer”, …]Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

string
required
The search query for job titles/positions. Use this to find matching job titles for people search filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_AUTOCOMPLETE_TECHNOLOGIESLookup technologies for use in company search filters. This endpoint returns a list of technology names that match the provided query string. Use this action to discover valid technology values before using them in company search filters. The results are sorted by relevance. Example: query=“react” might return [“React”, “React Native”, “ReactJS”, …]Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

string
required
The search query for technologies. Use this to find matching technology names for company search filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_COUNT_COMPANIESReturns the total count of companies matching the given search criteria without retrieving the actual results. Use this action to check how many companies match your filters before performing a full search. Free; no charge.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

array
The list of company types to filter by
array
The list IDs to filter by
string
The search query to apply on the company name and domain
array
The city IDs to filter by
array
The state IDs to filter by
object
Exclusion filters to apply on the companies.
array
The region IDs to filter by
array
The features that must exist for the company
array
The list of revenue ranges to filter by
array
The list of company categories to filter by
array
The keywords to filter by
array
The 2 letter country codes to filter by
array
The list of employee counts to filter by
array
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
object
The range of years
object
The range of years
array
The technologies to filter by
object
The funding amount range to filter by
array
The funding rounds to filter by
string
The semantic search query to find companies with. More natural language version of the standard query.
number
The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default.
object
Filter companies by workforce growth percentage over a selected period and department.
string ("And" | "Or")
The operator to apply to the filters. Defaults to And.
string ("And" | "Or")
The operator to apply to the filters. Defaults to And.
string ("And" | "Or")
The operator to apply to the filters. Defaults to And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_COUNT_SIMILAR_COMPANIESTool to count the total number of similar companies matching the given search criteria without retrieving the actual results. Use when you need to know how many similar companies exist before making a request to fetch them, or when you only need the count without the full company details. Free; no charge.Instant: Supported on the latest version.Instant pricing: $0 per request

Input Parameters

array
The list of company types to filter by.
string
The search query to apply on the company name and domain.
array
The city IDs to filter by.
array
The state IDs to filter by.
array
required
The domains to find similar companies for. Up to 10 domains are allowed.
object
Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.
array
The region IDs to filter by.
array
The features that must exist for the company.
array
The list of revenue ranges to filter by.
array
The list of company categories to filter by.
array
The keywords to filter by.
array
The 2 letter country codes to filter by.
array
The list of employee counts to filter by.
array
The NAICS codes to filter by. Can be 2 to 6 digit codes.
object
The range of years to filter by.
object
The funding year range to filter by.
array
The technologies to filter by.
object
The funding amount range to filter by.
array
The funding rounds to filter by.
object
Filter companies by workforce growth percentage over a selected period and department.
string ("And" | "Or")
Operator for category filters.
string ("And" | "Or")
Operator for category filters.
number
The similarity weight to apply to the results. Must be between -1 and 1. 0 is default.
string ("And" | "Or")
Operator for category filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_CREATE_BULK_ENRICHMENT_JOBCreate an asynchronous enrichment job for up to 10,000 domains. Costs 1 credit per domain successfully enriched, charged on completion. The workforce expansion costs 5 credits per company.

Input Parameters

array
Response expansions. workforce costs 5 credits per company.
array
required
Domains to enrich; between 1 and 10,000 domains are accepted.
string
Webhook URL notified when processing completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_CREATE_BULK_PERSON_EMAIL_JOBStart an asynchronous job containing 1 to 1,000 person email lookups. Each item costs up to 10 credits, charged on completion only when a newly accessed email is found. Beta: coverage, orchestration, and response behavior may change.

Input Parameters

array
required
Person email lookup items; between 1 and 1,000 are required.
string
Optional webhook URL notified when processing completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_CREATE_COMPANY_LISTCreate a durable company list from search or similar-company results. This action is charged per company added: search lists cost 1 credit per company (1-credit minimum); similar lists cost 5 credits per company (5-credit minimum). If no companies are found, CompanyEnrich does not create the list. Although count accepts up to 10,000, the provider selects only the first 5,000 results for the list.

Input Parameters

string
required
The name of the company list.
integer
required
The count schema accepts 1-10,000, but the provider selects only the first 5,000 matching results for a list.
Company filters for selecting list entries by search criteria.
object
Company filters for selecting list entries similar to seed domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_CREATE_PEOPLE_SEARCH_EXPORT_JOBCreates an asynchronous search export job for up to 50,000 people, returning a job ID and notifying a provided webhook on completion. Costs 2 credits per person returned, reserved when the job is created and settled on completion.

Input Parameters

integer
required
The number of people to export (1-1000000)
string
The search query to apply on the company name and domain
array
The domains to find people for. Up to 100 domains are allowed.
object
Exclusion filters to apply on the people. If a person matches any of the filters here, it will be excluded from the results.
array
The 2 letter country codes to filter by
array
The seniorities to filter by (e.g., c-suite, director, manager, senior, entry)
array
The departments to filter by (e.g., engineering-technical, sales, marketing, c-suite)
string
The webhook URL to receive the notification when processing completes.
object
The filters to be applied on the companies to find people for
array
The list of search queries to apply on the person’s current job position/title
string
Filter by current company join date - only include people who joined after this UTC date (ISO 8601 format)
string
Filter by current company join date - only include people who joined before this UTC date (ISO 8601 format)
string
Filter by current position start date - only include people who started after this UTC date (ISO 8601 format)
string
Filter by current position start date - only include people who started before this UTC date (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_CREATE_SEARCH_EXPORT_JOBCreates an asynchronous company search or similar-company export job for up to 50,000 companies, returning a job ID and notifying a provided webhook on completion. Costs 1 credit per company returned, reserved when the job is created and settled on completion.

Input Parameters

integer
required
The number of companies to export (up to 50,000).
object
Search filters to apply on the companies. Supports fields like query, keywords, countries, cities, states, regions, industries, categories, technologies, employees, revenue, fundingAmount, fundingRounds, foundedYear, naicsCode, and more.
object
Filters to find similar companies. Use the ‘domains’ field (up to 10 domains) to find companies similar to those domains.
string
The webhook URL to receive a notification when processing completes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_DELETE_COMPANY_LISTPermanently delete a company list and all of its entries.

Input Parameters

string
required
The UUID of the CompanyEnrich company list to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_ENRICH_BY_DOMAINEnriches a company using its domain name as lookup parameter. This is the preferred way to enrich a company as domain lookups are fast and reliable. Each domain maps to a unique company. Costs 1 credit per call (5 credits with the workforce expansion). Returns found=false with null company fields when no company matches the domain; there is no charge in that case.Instant: Supported on the latest version.Instant pricing: $0.009 per company enriched; $0.049 per company enriched with workforce data

Input Parameters

string
required
The domain name of the company to enrich (e.g., ‘stripe.com’).
array
Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (adds the workforce field; costs 5 credits per company).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_ENRICH_BY_PROPERTIESEnriches a company using its properties. You must provide at least one of the following properties: name, linkedinUrl, linkedinId, twitterUrl, facebookUrl, instagramUrl. Best match is used to determine the company in case of ambiguity. Costs 1 credit per call (5 credits with the workforce expansion).Instant: Supported on the latest version.Instant pricing: $0.009 per company enriched; $0.049 per company enriched with workforce data

Input Parameters

string
The name of the company to enrich.
array
Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (adds the workforce field; costs 5 credits per company).
string
The LinkedIn ID of the company to enrich.
string
The Twitter URL of the company to enrich.
string
The Facebook URL of the company to enrich.
string
The LinkedIn URL of the company to enrich.
string
The YouTube URL of the company to enrich.
string
The Instagram URL of the company to enrich.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_ENRICH_COMPANIESEnriches a list of companies using their domain names. Use when you need to enrich multiple companies in a single request. Up to 50 domains can be provided. Each domain maps to a unique company. Costs 1 credit per domain enriched (5 credits with the workforce expansion).Instant: Supported on the latest version.Instant pricing: $0.009 per company enriched; $0.049 with workforce data

Input Parameters

array
Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (adds the workforce field; costs 5 credits per company).
array
required
A list of domains to enrich. Up to 50 domains can be provided in a single request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_FIND_SIMILAR_COMPANIESTool to find similar companies to the given company by domain. Use when you need to find companies similar to a target company based on industry, size, or other characteristics. Returns up to 100 companies per request. Costs 5 credits per company returned, and 5 credits if no results are found.Instant: Supported on the latest version.Instant pricing: $0.049 per similar company returned (min $0.049); +$0.049 each with workforce.

Input Parameters

integer
The page number to return. Must be greater than 0.
array
The list of company types to filter by.
string
The search query to apply on the company name and domain.
array
The city IDs to filter by.
array
Expandable response fields. Supported values: workforce (adds the workforce field; costs 5 more credits per company).
array
The state IDs to filter by.
array
required
The domains to find similar companies for. Up to 10 domains are allowed.
array
The region IDs to filter by.
array
The features that must exist for the company.
array
The list of revenue ranges to filter by.
array
The list of company categories to filter by.
array
The keywords to filter by.
integer
The number of results to return. Must be between 1 and 100.
array
The 2 letter country codes to filter by.
array
The list of employee counts to filter by.
array
The NAICS codes to filter by. Can be 2 to 6 digit codes.
array
The technologies to filter by.
array
The funding rounds to filter by.
string ("And" | "Or")
Operator for category filters.
string ("And" | "Or")
Operator for category filters.
number
The similarity weight to apply to the results. Must be between -1 and 1. 0 is default.
string ("And" | "Or")
Operator for category filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_BULK_ENRICHMENT_JOB_STATUSReturns the current status of a bulk enrichment job. Once the job is completed, the response includes a results_url to download the enrichment results. Free; no charge. Use when you need to check the progress of a bulk enrichment job or get the results URL after the job completes.

Input Parameters

string
required
The unique identifier of the bulk enrichment job (UUID format). This ID is obtained when creating a bulk enrichment job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_BULK_PERSON_EMAIL_JOB_STATUSCheck a bulk person email job for free. Returns its status, credits_charged, and results_url when available; status checks are free. Beta: provider coverage, orchestration, and response behavior may change.

Input Parameters

string
required
The bulk person email job UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_COMPANYRetrieve a company by its CompanyEnrich UUID. Costs 1 credit per call. Requesting the workforce expansion costs 5 more credits per company.

Input Parameters

string
required
CompanyEnrich company UUID.
array
Optional response expansions. workforce costs 5 more credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_COMPANY_LISTRetrieve one saved company list by its UUID.

Input Parameters

string
required
The UUID of the CompanyEnrich company list to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_COMPANY_WORKFORCEReturns workforce insights for a single company. You must provide exactly one lookup parameter: id or domain. The response includes observed employee count, an employee range bucket, and headcounts grouped by root departments. Costs 5 credits per successful call. Returns found=false with null workforce fields when no company matches; there is no charge in that case. Use when you need to find workforce details (employee count, department breakdown) for a specific company given its domain or company ID.Instant: Supported on the latest version.Instant pricing: $0.049 per company workforce lookup

Input Parameters

string
CompanyEnrich company ID. Provide either id or domain.
string
Company domain. Provide either id or domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_COUNTRY_BY_CODETool to search for a country by its ISO 3166-1 alpha-2 code. Returns country information including name, coordinates, and country code. Use when you need to retrieve details about a specific country. Example: Get country details for US, GB, DE, etc.Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

string
required
The ISO 3166-1 alpha-2 country code (e.g., US, GB, DE, FR).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_CURRENT_USERReturns information about the authenticated user, including their credit balance and account capabilities. This endpoint requires authentication via an API key in the Authorization header. Free; no charge.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_JOB_DETAILSRetrieve details for a specific job by ID, including its status, timestamps, credits charged, and any error message. Free; no charge.

Input Parameters

string
required
The unique identifier of the job to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_PEOPLE_SEARCH_EXPORT_JOB_STATUSReturns the current status of a person search export job. Once completed, includes the results_url to download the export results. Use when: - Checking if an async person search export job has completed - Getting the download URL for completed exports - Monitoring job progress or checking for errors Status checks are free.

Input Parameters

string
required
The unique identifier (UUID) of the person search export job to check the status of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_PERSONRetrieve a person by CompanyEnrich ID for 2 credits. Optionally request the education expansion, which adds 1 credit.

Input Parameters

string
required
The CompanyEnrich person ID.
array
Optional response expansions. The lookup costs 2 credits; education adds 1 credit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_PERSON_EDUCATIONRetrieve a person’s education history. Costs 1 credit per successful call.

Input Parameters

string
required
The CompanyEnrich person ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_REGIONSTool to get all available regions. Returns a list of all geographic regions supported by the API. Use when you need to retrieve region information for filtering or validation purposes.Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_GET_SEARCH_EXPORT_JOB_STATUSReturns the current status of a search export job. Once the job is completed, the response will include a results_url that can be used to download the exported company data. This action is free. Use this action to: - Check if an export job has completed - Get the download URL for completed exports - Monitor job progress and troubleshoot failures

Input Parameters

string
required
The unique identifier (UUID) of the search export job. This is returned when you create an export job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LIST_ALL_JOBSReturns a paginated list of all jobs (bulk enrichment, etc.) for the authenticated user. Supports optional filtering by job status and type. Free; no charge. Use this action to: - View all your jobs - Check the status of jobs - Monitor job progress and completion - Filter jobs by status (pending, processing, completed, failed, etc.) - Filter jobs by type (bulk_enrichment, etc.)

Input Parameters

integer
Page number (default: 1).
string
Filter jobs by type (bulk_enrichment, etc.).
string ("pending" | "processing" | "completing" | "completed" | "failed")
Filter jobs by status.
integer
Number of items per page (default: 20, max: 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LIST_BULK_ENRICHMENT_JOBSReturns a paginated list of all bulk enrichment jobs for the authenticated user. Supports optional filtering by job status. This action is free. Use this action to: - View all your bulk enrichment jobs - Check the status of enrichment jobs - Monitor enrichment job progress and completion - Filter jobs by status (pending, processing, completing, completed, failed)

Input Parameters

integer
Page number (default: 1).
string ("pending" | "processing" | "completing" | "completed" | "failed")
Filter jobs by status.
integer
Number of items per page (default: 20, max: 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LIST_COMPANY_LISTSReturn all saved company lists for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LIST_INDUSTRIESObtain a list of all company industries. Returns all industry names along with their associated NAICS code prefixes. Use when you need to retrieve the complete list of industries for filtering or categorization.Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LIST_PEOPLE_SEARCH_EXPORT_JOBSReturns a free, paginated list of the authenticated user’s person search export jobs, optionally filtered by status. Use it to check job status and export progress.

Input Parameters

integer
Page number for pagination (default: 1).
string ("pending" | "processing" | "completing" | "completed" | "failed")
Status of the async export job.
integer
Number of items per page (default: 20, max: 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LIST_SEARCH_EXPORT_JOBSLists the authenticated user’s company search export jobs in pages, optionally filtered by status. The action is free.

Input Parameters

integer
Page number (default: 1).
string ("pending" | "processing" | "completing" | "completed" | "failed")
Filter jobs by status.
integer
Number of items per page (default: 20, max: 100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LOOKUP_PERSONLook up a person by email address. We resolve the company from the email domain first, then match the person by email local-part patterns. Returns the best deterministic match when found. Costs 5 credits per successful call. Use when you need to find person details (name, position, company, etc.) given an email address.Instant: Supported on the latest version.Instant pricing: $0.049 per person found

Input Parameters

string
required
The email address of the person to look up (e.g., ‘sarah.chen@stripe.com’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_LOOKUP_PERSON_EMAIL_BY_IDResolve a work email for a person, optionally on a specific domain. Charged only when a newly accessed email is found. Beta: provider coverage and response behavior may change.

Input Parameters

string
required
The CompanyEnrich person ID.
string
Optional company domain to resolve the email on. If omitted, current experience domains are tried in seniority order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_PREVIEW_COMPANY_SEARCHPreview the top 25 companies matching a search. Free; no charge. Requirements: Requires Scale plans. Notice: Returns the top 25 results only.

Input Parameters

array
Company types to include.
array
Saved list IDs to filter by.
string
Query applied to company names and domains.
array
City IDs to include.
array
State IDs to include.
object
Filters that exclude matching companies.
array
Region IDs to include.
array
Company features that must be present.
array
Revenue ranges to include.
array
Company categories to include.
array
Keywords to include.
array
Two-letter country codes to include.
array
Employee-count ranges to include.
array
NAICS codes to include.
object
Company founding-year range.
object
Company funding-year range.
array
Technologies to include.
object
Company funding-amount range.
array
Funding rounds to include.
string
Natural-language semantic company search query.
array
Absolute workforce filters by department.
number
Semantic ranking weight from 0 to 1.
object
Workforce growth filter.
string ("And" | "Or")
Operator for category filters; defaults to And.
string ("And" | "Or")
Operator for keyword filters; defaults to And.
array
Reported employee-count ranges to include.
string ("And" | "Or")
Operator for technology filters; defaults to And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_PREVIEW_SIMILAR_COMPANIESPreview the top 25 similar companies for free. Requires a Scale plan. By default, a missing seed company is enriched on demand. With wait_for_enrichment=False, missing domains are scheduled for background enrichment and the request returns 404 with no charge.

Input Parameters

string
Text query applied to company names and domains.
array
City IDs to include.
array
State IDs to include.
array
Seed company domains. Provide between 1 and 10 domains.
object
Company filters that exclude matching results.
array
Region IDs to include.
array
Company features that each result must have.
array
Revenue ranges to include.
array
Company categories to include.
array
Keywords to include.
array
Two-letter country codes to include.
array
Employee-count ranges to include.
number
Minimum similarity score from 0 to 1.
array
NAICS codes, from 2 through 6 digits, to include.
object
Inclusive founded-year range with optional min and max values.
object
Inclusive funding-year range with optional min and max values.
array
Technologies to include.
array
Company types to include.
object
Inclusive funding amount range with optional min and max values.
array
Funding round types to include.
array
Absolute workforce headcount filters, optionally by department.
object
Workforce growth filter including period, department, and percent bounds.
string ("And" | "Or")
Operator used to combine category filters.
string ("And" | "Or")
Operator used to combine keyword filters.
number
Similarity weighting from -1 to 1; larger values prioritize similarity.
array
Externally reported employee-count ranges to include.
boolean
Wait for missing seed companies to be enriched. When false, missing domains are scheduled in the background and the request returns 404 with no charge.
string ("And" | "Or")
Operator used to combine technology filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SCROLL_COMPANY_SEARCHSearch and continue company results with an opaque cursor. Costs 1 credit per company returned, with a 1-credit minimum when no results are found. The optional workforce expansion costs 5 credits per company. Returns at most 100 companies per request and supports results beyond 10,000.

Input Parameters

array
Company types to include.
array
Saved list IDs to filter by.
string
Query applied to company names and domains.
array
City IDs to include.
string
Opaque cursor returned by the preceding scroll response.
array
Response expansions. workforce costs 5 credits per company.
array
State IDs to include.
object
Filters that exclude matching companies.
array
Region IDs to include.
array
Company features that must be present.
array
Revenue ranges to include.
array
Company categories to include.
array
Keywords to include.
integer
Number of companies to return, between 1 and 100.
array
Two-letter country codes to include.
array
Employee-count ranges to include.
array
NAICS codes to include.
object
Company founding-year range.
object
Company funding-year range.
array
Technologies to include.
object
Company funding-amount range.
array
Funding rounds to include.
string
Natural-language semantic company search query.
array
Absolute workforce filters by department.
number
Semantic ranking weight from 0 to 1.
object
Workforce growth filter.
string ("And" | "Or")
Operator for category filters; defaults to And.
string ("And" | "Or")
Operator for keyword filters; defaults to And.
array
Reported employee-count ranges to include.
string ("And" | "Or")
Operator for technology filters; defaults to And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SCROLL_PEOPLE_SEARCHSearches people based on given criteria using cursor-based pagination. Use when you need to find people at specific companies or with particular roles. You can request the next page of results by using the cursor parameter. Costs 2 credits per person returned, with a 2-credit minimum if no results are found.Instant: Supported on the latest version.Instant pricing: $0.019 per person returned; at least one result is billed per request.

Input Parameters

string
The search query to apply on the company name and domain
string
The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.
array
The domains to find people for. Up to 100 domains are allowed.
array
The 2 letter country codes to filter by
integer
The number of results to return in each page. Must be between 1 and 100
array
The seniorities to filter by (e.g., c-suite, director, manager, senior, entry)
array
The departments to filter by (e.g., engineering-technical, sales, marketing)
array
The list of search queries to apply on the person’s current job position/title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SCROLL_SIMILAR_COMPANIESScroll similar-company results using an opaque cursor. Costs 5 credits per company returned, with a 5-credit minimum when no results are found. By default, a missing seed company is enriched on demand. With wait_for_enrichment=False, missing domains are scheduled for background enrichment and the request returns 404 with no charge.

Input Parameters

string
Text query applied to company names and domains.
array
City IDs to include.
string
Opaque cursor returned by a previous call; omit for the first page.
array
Optional response expansions. workforce costs 5 more credits per company.
array
State IDs to include.
array
Seed company domains. Provide between 1 and 10 domains.
object
Company filters that exclude matching results.
array
Region IDs to include.
array
Company features that each result must have.
array
Revenue ranges to include.
array
Company categories to include.
array
Keywords to include.
array
Two-letter country codes to include.
array
Employee-count ranges to include.
number
Minimum similarity score from 0 to 1.
integer
Number of companies to return, from 1 through 100.
array
NAICS codes, from 2 through 6 digits, to include.
object
Inclusive founded-year range with optional min and max values.
object
Inclusive funding-year range with optional min and max values.
array
Technologies to include.
array
Company types to include.
object
Inclusive funding amount range with optional min and max values.
array
Funding round types to include.
array
Absolute workforce headcount filters, optionally by department.
object
Workforce growth filter including period, department, and percent bounds.
string ("And" | "Or")
Operator used to combine category filters.
string ("And" | "Or")
Operator used to combine keyword filters.
number
Similarity weighting from -1 to 1; larger values prioritize similarity.
array
Externally reported employee-count ranges to include.
boolean
Wait for missing seed companies to be enriched. When false, missing domains are scheduled in the background and the request returns 404 with no charge.
string ("And" | "Or")
Operator used to combine technology filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SEARCH_CITIESSearch for cities by name or country codes. Returns up to 100 cities per page. Use when you need to find cities matching a query string, optionally filtered by country codes.Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

integer
The page number to retrieve. 1-indexed.
string
The city name to search for. Maximum 30 characters.
array
Filter cities by country codes (ISO 2-letter codes).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SEARCH_COMPANIESSearches companies based on given criteria. You can search by name, domain, industry, employees, revenue, founded year, and more. Up to 10,000 results can be returned from this endpoint (page * pageSize cannot exceed 10,000). For more results, use the scroll endpoint. Costs 1 credit per company returned, with a 1-credit minimum if no results are found.Instant: Supported on the latest version.Instant pricing: $0.009 per company returned; at least one result is billed per request.

Input Parameters

integer
The page number to return. Must be greater than 0
array
The list of company types to filter by
array
The list IDs to filter by
string
The search query to apply on the company name and domain
array
The city IDs to filter by
array
The state IDs to filter by
object
Exclusion filters to apply on the companies.
array
The region IDs to filter by
array
The features that must exist for the company
array
The list of revenue ranges to filter by
array
The list of company categories to filter by
array
The keywords to filter by
array
The 2 letter country codes to filter by
array
The list of employee counts to filter by
integer
The number of results to return in each page. Must be between 1 and 100
array
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
object
The range of years
object
The range of years
array
The technologies to filter by
object
The funding amount range to filter by
array
The funding rounds to filter by
string
The semantic search query to find companies with. More natural language version of the standard query.
number
The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default.
object
Filter companies by workforce growth percentage over a selected period and department.
string ("And" | "Or")
The operator to apply to the filters. Defaults to And.
string ("And" | "Or")
The operator to apply to the filters. Defaults to And.
string ("And" | "Or")
The operator to apply to the filters. Defaults to And.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SEARCH_COUNTRIESTool to search countries by name. Returns up to 100 countries per page. Use when you need to find country information including codes, names, and coordinates. Supports pagination and filtering by name query.Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

integer
Page number for pagination. 1-indexed.
string
Search query to filter countries by name. Maximum 30 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SEARCH_PEOPLESearches people based on given criteria using page-based pagination. Up to 10,000 results can be returned from this endpoint (page * pageSize cannot exceed 10,000). For more results, use the scroll endpoint. Costs 2 credits per person returned, with a 2-credit minimum if no results are found.Instant: Supported on the latest version.Instant pricing: $0.019 per person returned; at least one result is billed per request.

Input Parameters

integer
required
The page number to return. Must be greater than 0
string
The search query to apply on the company name and domain
array
The domains to find people for. Up to 100 domains are allowed.
integer
required
The number of results to return in each page. Must be between 1 and 100
array
The 2 letter country codes to filter by
array
The seniorities to filter by
array
The departments to filter by
array
The list of search queries to apply on the person’s current job position/title

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_SEARCH_STATESTool to search states by name or country codes. Returns up to 100 states per page. Use when you need to find states within a country or search states by name.Instant: Supported on the latest version.Instant pricing: $0.009 per credit used.

Input Parameters

integer
The page number to retrieve (1-indexed).
string
The search query for state name (max 30 characters).
array
List of country codes to filter states by (e.g., [‘US’, ‘CA’]).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: COMPANYENRICH_UPDATE_COMPANY_LISTRename a saved company list. This is a durable mutation of the list.

Input Parameters

string
required
The UUID of the CompanyEnrich company list to update.
string
required
The new durable name for the company list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not