Companyenrich

companyenrich

CompanyEnrich provides instant company data enrichment, search, and similar company discovery through API endpoints.

Developer Tools Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (32)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Autocomplete CompaniesCOMPANYENRICH_AUTOCOMPLETE_COMPANIESAcción

Returns 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. Cost: FREE - No credits deducted. Use when you need to autocomplete company domains in your application.

Parámetros de entrada

querystringObligatorio
The domain name to autocomplete (e.g., 'google', 'stripe', 'amazon')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Autocomplete KeywordsCOMPANYENRICH_AUTOCOMPLETE_KEYWORDSAcción

Lookup 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", ...]

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Autocomplete PositionsCOMPANYENRICH_AUTOCOMPLETE_POSITIONSAcción

Lookup 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", ...]

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Autocomplete TechnologiesCOMPANYENRICH_AUTOCOMPLETE_TECHNOLOGIESAcción

Lookup 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", ...]

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Count companies matching search criteriaCOMPANYENRICH_COUNT_COMPANIESAcción

Returns 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. Cost: FREE - No credits deducted.

Parámetros de entrada

typestring[]
The list of company types to filter by
listsstring[]
The list IDs to filter by
querystring
The search query to apply on the company name and domain
citiesinteger[]
The city IDs to filter by
statesinteger[]
The state IDs to filter by
excludeobject
Exclusion filters to apply on the companies.
regionsstring[]
The region IDs to filter by
requirestring[]
The features that must exist for the company
revenuestring[]
The list of revenue ranges to filter by
categorystring[]
The list of company categories to filter by
keywordsstring[]
The keywords to filter by
countriesstring[]
The 2 letter country codes to filter by
employeesstring[]
The list of employee counts to filter by
naics_codeinteger[]
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
founded_yearobject
The range of years
funding_yearobject
The range of years
technologiesstring[]
The technologies to filter by
funding_amountobject
The funding amount range to filter by
funding_roundsstring[]
The funding rounds to filter by
semantic_querystring
The semantic search query to find companies with. More natural language version of the standard query.
semantic_weightnumber
The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default.
workforce_growthobject
Filter companies by workforce growth percentage over a selected period and department.
category_operatorstringenum
The operator to apply to the filters. Defaults to And.
AndOr
keywords_operatorstringenum
The operator to apply to the filters. Defaults to And.
AndOr
technologies_operatorstringenum
The operator to apply to the filters. Defaults to And.
AndOr

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Count Similar CompaniesCOMPANYENRICH_COUNT_SIMILAR_COMPANIESAcción

Tool 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. Cost: FREE - No credits deducted.

Parámetros de entrada

typestring[]
The list of company types to filter by.
querystring
The search query to apply on the company name and domain.
citiesinteger[]
The city IDs to filter by.
statesinteger[]
The state IDs to filter by.
domainsstring[]Obligatorio
The domains to find similar companies for. Up to 10 domains are allowed.
excludeobject
Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.
regionsstring[]
The region IDs to filter by.
requirestring[]
The features that must exist for the company.
revenuestring[]
The list of revenue ranges to filter by.
categorystring[]
The list of company categories to filter by.
keywordsstring[]
The keywords to filter by.
countriesstring[]
The 2 letter country codes to filter by.
employeesstring[]
The list of employee counts to filter by.
naicsCodeinteger[]
The NAICS codes to filter by. Can be 2 to 6 digit codes.
foundedYearobject
The range of years to filter by.
fundingYearobject
The funding year range to filter by.
technologiesstring[]
The technologies to filter by.
fundingAmountobject
The funding amount range to filter by.
fundingRoundsstring[]
The funding rounds to filter by.
workforceGrowthobject
Filter companies by workforce growth percentage over a selected period and department.
categoryOperatorstringenum
Operator for category filters.
AndOr
keywordsOperatorstringenum
Operator for category filters.
AndOr
similarityWeightnumber
The similarity weight to apply to the results. Must be between -1 and 1. 0 is default.
technologiesOperatorstringenum
Operator for category filters.
AndOr

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create people search export jobCOMPANYENRICH_CREATE_PEOPLE_SEARCH_EXPORT_JOBAcción

Creates an asynchronous search export job for up to 50,000 people. Use when you need to export large sets of people data that will be processed in the background. The job returns immediately with a job ID, and the webhook URL will be called with a notification when processing completes. Cost: 2 credits per person returned (charged on completion).

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create search export jobCOMPANYENRICH_CREATE_SEARCH_EXPORT_JOBAcción

Creates an asynchronous search export job for company data. Supports both standard company search and similar-company search. Returns a job ID immediately while processing happens in the background. The webhook URL (if provided) will be called with a notification when processing completes. Cost: 1 credit per company returned (charged on completion). Use this action when you need to export large datasets (up to 50,000 companies) that would take too long for a synchronous request. The job runs asynchronously and notifies you via webhook when complete.

Parámetros de entrada

countintegerObligatorio
The number of companies to export (up to 50,000).
searchobject
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.
similarobject
Filters to find similar companies. Use the 'domains' field (up to 10 domains) to find companies similar to those domains.
webhook_urlstring
The webhook URL to receive a notification when processing completes.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enrich company by domainCOMPANYENRICH_ENRICH_BY_DOMAINAcción

Enriches 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. Cost: 1 credit per call (5 credits if workforce expansion is requested).

Parámetros de entrada

domainstringObligatorio
The domain name of the company to enrich (e.g., 'stripe.com').
expandstring[]
Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (costs 5 credits per company and adds the workforce field).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Enrich company by propertiesCOMPANYENRICH_ENRICH_BY_PROPERTIESAcción

Enriches 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. Cost: 1 credit per call (5 credits if workforce expansion is requested).

Parámetros de entrada

namestring
The name of the company to enrich.
expandstring[]
Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (costs 5 credits per company and adds the workforce field).
linkedin_idstring
The LinkedIn ID of the company to enrich.
twitter_urlstring
The Twitter URL of the company to enrich.
facebook_urlstring
The Facebook URL of the company to enrich.
linkedin_urlstring
The LinkedIn URL of the company to enrich.
you_tube_urlstring
The YouTube URL of the company to enrich.
instagram_urlstring
The Instagram URL of the company to enrich.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Batch Enrich CompaniesCOMPANYENRICH_ENRICH_COMPANIESAcción

Enriches 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. Cost: 1 credit per domain enriched (5 credits for workforce expansion).

Parámetros de entrada

expandstring[]
Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: `workforce` (costs 5 credits per company and adds the `workforce` field).
domainsstring[]Obligatorio
A list of domains to enrich. Up to 50 domains can be provided in a single request.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Find Similar CompaniesCOMPANYENRICH_FIND_SIMILAR_COMPANIESAcción

Tool 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. Cost: 5 credits per company returned, 5 credits if no results found.

Parámetros de entrada

pageinteger
The page number to return. Must be greater than 0.
typestring[]
The list of company types to filter by.
querystring
The search query to apply on the company name and domain.
citiesinteger[]
The city IDs to filter by.
expandstring[]
Expandable response fields. Supported values: workforce (costs 5 credits per company and adds the workforce field).
statesinteger[]
The state IDs to filter by.
domainsstring[]Obligatorio
The domains to find similar companies for. Up to 10 domains are allowed.
regionsstring[]
The region IDs to filter by.
requirestring[]
The features that must exist for the company.
revenuestring[]
The list of revenue ranges to filter by.
categorystring[]
The list of company categories to filter by.
keywordsstring[]
The keywords to filter by.
pageSizeinteger
The number of results to return. Must be between 1 and 100.
countriesstring[]
The 2 letter country codes to filter by.
employeesstring[]
The list of employee counts to filter by.
naicsCodeinteger[]
The NAICS codes to filter by. Can be 2 to 6 digit codes.
technologiesstring[]
The technologies to filter by.
fundingRoundsstring[]
The funding rounds to filter by.
categoryOperatorstringenum
Operator for category filters.
AndOr
keywordsOperatorstringenum
Operator for category filters.
AndOr
similarityWeightnumber
The similarity weight to apply to the results. Must be between -1 and 1. 0 is default.
technologiesOperatorstringenum
Operator for category filters.
AndOr

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Bulk Enrichment Job StatusCOMPANYENRICH_GET_BULK_ENRICHMENT_JOB_STATUSAcción

Returns the current status of a bulk enrichment job. Once the job is completed, the response includes a results_url to download the enrichment results. Cost: FREE - No credits deducted. Use when you need to check the progress of a bulk enrichment job or get the results URL after the job completes.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Company WorkforceCOMPANYENRICH_GET_COMPANY_WORKFORCEAcción

Returns 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. Use when you need to find workforce details (employee count, department breakdown) for a specific company given its domain or company ID.

Parámetros de entrada

idstring
CompanyEnrich company ID. Provide either `id` or `domain`.
domainstring
Company domain. Provide either `id` or `domain`.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Country by CodeCOMPANYENRICH_GET_COUNTRY_BY_CODEAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Current UserCOMPANYENRICH_GET_CURRENT_USERAcción

Returns information about the authenticated user, including their API key, credit balance, and account capabilities. This endpoint requires authentication via an API key in the Authorization header. Cost: FREE - No credits deducted.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Job DetailsCOMPANYENRICH_GET_JOB_DETAILSAcción

Returns details for a specific job by ID. Use when you need to check the status, progress, or result of an async enrichment job. Cost: FREE - No credits deducted.

Parámetros de entrada

job_idstringObligatorio
The unique identifier of the job to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get People Search Export Job StatusCOMPANYENRICH_GET_PEOPLE_SEARCH_EXPORT_JOB_STATUSAcción

Returns 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 Cost: FREE - No credits deducted for status checks.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get RegionsCOMPANYENRICH_GET_REGIONSAcción

Tool 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get search export job statusCOMPANYENRICH_GET_SEARCH_EXPORT_JOB_STATUSAcción

Returns 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 - no credits are deducted. Use this action to: - Check if an export job has completed - Get the download URL for completed exports - Monitor job progress and troubleshoot failures

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List all jobsCOMPANYENRICH_LIST_ALL_JOBSAcción

Returns a paginated list of all jobs (bulk enrichment, etc.) for the authenticated user. Supports optional filtering by job status and type. Cost: FREE - No credits deducted. 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.)

Parámetros de entrada

pageinteger
Page number (default: 1).
typestring
Filter jobs by type (bulk_enrichment, etc.).
statusstringenum
Filter jobs by status.
pendingprocessingcompletingcompletedfailed
pageSizeinteger
Number of items per page (default: 20, max: 100).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List bulk enrichment jobsCOMPANYENRICH_LIST_BULK_ENRICHMENT_JOBSAcción

Returns a paginated list of all bulk enrichment jobs for the authenticated user. Supports optional filtering by job status. This action is free - no credits are deducted. 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)

Parámetros de entrada

pageinteger
Page number (default: 1).
statusstringenum
Filter jobs by status.
pendingprocessingcompletingcompletedfailed
pageSizeinteger
Number of items per page (default: 20, max: 100).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List IndustriesCOMPANYENRICH_LIST_INDUSTRIESAcción

Obtain 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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Person Search Export JobsCOMPANYENRICH_LIST_PEOPLE_SEARCH_EXPORT_JOBSAcción

Returns a paginated list of all person search export jobs for the authenticated user. Supports optional filtering by job status. Use this to check the status of previously submitted export jobs, view progress, or retrieve export results. Cost: FREE - No credits deducted.

Parámetros de entrada

pageinteger
Page number for pagination (default: 1).
statusstringenum
Status of the async export job.
pendingprocessingcompletingcompletedfailed
page_sizeinteger
Number of items per page (default: 20, max: 100).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List search export jobsCOMPANYENRICH_LIST_SEARCH_EXPORT_JOBSAcción

Returns a paginated list of all search export jobs for the authenticated user. Supports optional filtering by job status. This action is free - no credits are deducted. Use this action to: - View all your search export jobs - Check the status of export jobs - Monitor export job progress and completion - Filter jobs by status (pending, processing, completed, failed, etc.)

Parámetros de entrada

pageinteger
Page number (default: 1).
statusstringenum
Filter jobs by status.
pendingprocessingcompletingcompletedfailed
pageSizeinteger
Number of items per page (default: 20, max: 100).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Lookup Person by EmailCOMPANYENRICH_LOOKUP_PERSONAcción

Look 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.

Parámetros de entrada

emailstringObligatorio
The email address of the person to look up (e.g., 'sarah.chen@stripe.com')

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search people with cursor paginationCOMPANYENRICH_SCROLL_PEOPLE_SEARCHAcción

Searches 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. Cost: 2 credits per person returned, 2 credits minimum if no results are found.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search cities by name or countryCOMPANYENRICH_SEARCH_CITIESAcción

Search 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.

Parámetros de entrada

pageinteger
The page number to retrieve. 1-indexed.
querystring
The city name to search for. Maximum 30 characters.
country_codesstring[]
Filter cities by country codes (ISO 2-letter codes).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search companies by criteriaCOMPANYENRICH_SEARCH_COMPANIESAcción

Searches 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. Cost: 1 credit per company returned, 1 credit minimum if no results are found.

Parámetros de entrada

pageinteger
The page number to return. Must be greater than 0
typestring[]
The list of company types to filter by
listsstring[]
The list IDs to filter by
querystring
The search query to apply on the company name and domain
citiesinteger[]
The city IDs to filter by
statesinteger[]
The state IDs to filter by
excludeobject
Exclusion filters to apply on the companies.
regionsstring[]
The region IDs to filter by
requirestring[]
The features that must exist for the company
revenuestring[]
The list of revenue ranges to filter by
categorystring[]
The list of company categories to filter by
keywordsstring[]
The keywords to filter by
countriesstring[]
The 2 letter country codes to filter by
employeesstring[]
The list of employee counts to filter by
page_sizeinteger
The number of results to return in each page. Must be between 1 and 100
naics_codeinteger[]
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
founded_yearobject
The range of years
funding_yearobject
The range of years
technologiesstring[]
The technologies to filter by
funding_amountobject
The funding amount range to filter by
funding_roundsstring[]
The funding rounds to filter by
semantic_querystring
The semantic search query to find companies with. More natural language version of the standard query.
semantic_weightnumber
The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default.
workforce_growthobject
Filter companies by workforce growth percentage over a selected period and department.
category_operatorstringenum
The operator to apply to the filters. Defaults to And.
AndOr
keywords_operatorstringenum
The operator to apply to the filters. Defaults to And.
AndOr
technologies_operatorstringenum
The operator to apply to the filters. Defaults to And.
AndOr

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search CountriesCOMPANYENRICH_SEARCH_COUNTRIESAcción

Tool 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.

Parámetros de entrada

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

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search PeopleCOMPANYENRICH_SEARCH_PEOPLEAcción

Searches 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. Cost: 2 credits per person returned, 2 credits minimum if no results are found.

Parámetros de entrada

pageintegerObligatorio
The page number to return. Must be greater than 0
querystring
The search query to apply on the company name and domain
domainsstring[]
The domains to find people for. Up to 100 domains are allowed.
pageSizeintegerObligatorio
The number of results to return in each page. Must be between 1 and 100
countriesstring[]
The 2 letter country codes to filter by
senioritystring[]
The seniorities to filter by
departmentstring[]
The departments to filter by
positionQuerystring[]
The list of search queries to apply on the person's current job position/title

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search StatesCOMPANYENRICH_SEARCH_STATESAcción

Tool 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.

Parámetros de entrada

pageinteger
The page number to retrieve (1-indexed).
querystring
The search query for state name (max 30 characters).
country_codesstring[]
List of country codes to filter states by (e.g., ['US', 'CA']).

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not