# Companyenrich

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

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 32
- **Triggers:** 0
- **Slug:** `COMPANYENRICH`
- **Version:** 00000000_00

## Tools

### Autocomplete Companies

**Slug:** `COMPANYENRICH_AUTOCOMPLETE_COMPANIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The domain name to autocomplete (e.g., 'google', 'stripe', 'amazon') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Autocomplete Keywords

**Slug:** `COMPANYENRICH_AUTOCOMPLETE_KEYWORDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The search query for keywords. Use this to find matching keywords for company search filters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Autocomplete Positions

**Slug:** `COMPANYENRICH_AUTOCOMPLETE_POSITIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The search query for job titles/positions. Use this to find matching job titles for people search filters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Autocomplete Technologies

**Slug:** `COMPANYENRICH_AUTOCOMPLETE_TECHNOLOGIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | The search query for technologies. Use this to find matching technology names for company search filters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count companies matching search criteria

**Slug:** `COMPANYENRICH_COUNT_COMPANIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | array | No | The list of company types to filter by |
| `lists` | array | No | The list IDs to filter by |
| `query` | string | No | The search query to apply on the company name and domain |
| `cities` | array | No | The city IDs to filter by |
| `states` | array | No | The state IDs to filter by |
| `exclude` | object | No | Exclusion filters to apply on the companies. |
| `regions` | array | No | The region IDs to filter by |
| `require` | array | No | The features that must exist for the company |
| `revenue` | array | No | The list of revenue ranges to filter by |
| `category` | array | No | The list of company categories to filter by |
| `keywords` | array | No | The keywords to filter by |
| `countries` | array | No | The 2 letter country codes to filter by |
| `employees` | array | No | The list of employee counts to filter by |
| `naics_code` | array | No | 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_year` | object | No | The range of years |
| `funding_year` | object | No | The range of years |
| `technologies` | array | No | The technologies to filter by |
| `funding_amount` | object | No | The funding amount range to filter by |
| `funding_rounds` | array | No | The funding rounds to filter by |
| `semantic_query` | string | No | The semantic search query to find companies with. More natural language version of the standard query. |
| `semantic_weight` | number | No | The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. |
| `workforce_growth` | object | No | Filter companies by workforce growth percentage over a selected period and department. |
| `category_operator` | string ("And" | "Or") | No | The operator to apply to the filters. Defaults to And. |
| `keywords_operator` | string ("And" | "Or") | No | The operator to apply to the filters. Defaults to And. |
| `technologies_operator` | string ("And" | "Or") | No | The operator to apply to the filters. Defaults to And. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Count Similar Companies

**Slug:** `COMPANYENRICH_COUNT_SIMILAR_COMPANIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | array | No | The list of company types to filter by. |
| `query` | string | No | The search query to apply on the company name and domain. |
| `cities` | array | No | The city IDs to filter by. |
| `states` | array | No | The state IDs to filter by. |
| `domains` | array | Yes | The domains to find similar companies for. Up to 10 domains are allowed. |
| `exclude` | object | No | Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results. |
| `regions` | array | No | The region IDs to filter by. |
| `require` | array | No | The features that must exist for the company. |
| `revenue` | array | No | The list of revenue ranges to filter by. |
| `category` | array | No | The list of company categories to filter by. |
| `keywords` | array | No | The keywords to filter by. |
| `countries` | array | No | The 2 letter country codes to filter by. |
| `employees` | array | No | The list of employee counts to filter by. |
| `naicsCode` | array | No | The NAICS codes to filter by. Can be 2 to 6 digit codes. |
| `foundedYear` | object | No | The range of years to filter by. |
| `fundingYear` | object | No | The funding year range to filter by. |
| `technologies` | array | No | The technologies to filter by. |
| `fundingAmount` | object | No | The funding amount range to filter by. |
| `fundingRounds` | array | No | The funding rounds to filter by. |
| `workforceGrowth` | object | No | Filter companies by workforce growth percentage over a selected period and department. |
| `categoryOperator` | string ("And" | "Or") | No | Operator for category filters. |
| `keywordsOperator` | string ("And" | "Or") | No | Operator for category filters. |
| `similarityWeight` | number | No | The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. |
| `technologiesOperator` | string ("And" | "Or") | No | Operator for category filters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create people search export job

**Slug:** `COMPANYENRICH_CREATE_PEOPLE_SEARCH_EXPORT_JOB`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create search export job

**Slug:** `COMPANYENRICH_CREATE_SEARCH_EXPORT_JOB`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | Yes | The number of companies to export (up to 50,000). |
| `search` | object | No | 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. |
| `similar` | object | No | Filters to find similar companies. Use the 'domains' field (up to 10 domains) to find companies similar to those domains. |
| `webhook_url` | string | No | The webhook URL to receive a notification when processing completes. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich company by domain

**Slug:** `COMPANYENRICH_ENRICH_BY_DOMAIN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | The domain name of the company to enrich (e.g., 'stripe.com'). |
| `expand` | array | No | Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (costs 5 credits per company and adds the workforce field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Enrich company by properties

**Slug:** `COMPANYENRICH_ENRICH_BY_PROPERTIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | The name of the company to enrich. |
| `expand` | array | No | Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: workforce (costs 5 credits per company and adds the workforce field). |
| `linkedin_id` | string | No | The LinkedIn ID of the company to enrich. |
| `twitter_url` | string | No | The Twitter URL of the company to enrich. |
| `facebook_url` | string | No | The Facebook URL of the company to enrich. |
| `linkedin_url` | string | No | The LinkedIn URL of the company to enrich. |
| `you_tube_url` | string | No | The YouTube URL of the company to enrich. |
| `instagram_url` | string | No | The Instagram URL of the company to enrich. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Enrich Companies

**Slug:** `COMPANYENRICH_ENRICH_COMPANIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | Expandable response fields. Repeat the parameter to request multiple expansions. Supported values: `workforce` (costs 5 credits per company and adds the `workforce` field). |
| `domains` | array | Yes | A list of domains to enrich. Up to 50 domains can be provided in a single request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Find Similar Companies

**Slug:** `COMPANYENRICH_FIND_SIMILAR_COMPANIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to return. Must be greater than 0. |
| `type` | array | No | The list of company types to filter by. |
| `query` | string | No | The search query to apply on the company name and domain. |
| `cities` | array | No | The city IDs to filter by. |
| `expand` | array | No | Expandable response fields. Supported values: workforce (costs 5 credits per company and adds the workforce field). |
| `states` | array | No | The state IDs to filter by. |
| `domains` | array | Yes | The domains to find similar companies for. Up to 10 domains are allowed. |
| `regions` | array | No | The region IDs to filter by. |
| `require` | array | No | The features that must exist for the company. |
| `revenue` | array | No | The list of revenue ranges to filter by. |
| `category` | array | No | The list of company categories to filter by. |
| `keywords` | array | No | The keywords to filter by. |
| `pageSize` | integer | No | The number of results to return. Must be between 1 and 100. |
| `countries` | array | No | The 2 letter country codes to filter by. |
| `employees` | array | No | The list of employee counts to filter by. |
| `naicsCode` | array | No | The NAICS codes to filter by. Can be 2 to 6 digit codes. |
| `technologies` | array | No | The technologies to filter by. |
| `fundingRounds` | array | No | The funding rounds to filter by. |
| `categoryOperator` | string ("And" | "Or") | No | Operator for category filters. |
| `keywordsOperator` | string ("And" | "Or") | No | Operator for category filters. |
| `similarityWeight` | number | No | The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. |
| `technologiesOperator` | string ("And" | "Or") | No | Operator for category filters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bulk Enrichment Job Status

**Slug:** `COMPANYENRICH_GET_BULK_ENRICHMENT_JOB_STATUS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The unique identifier of the bulk enrichment job (UUID format). This ID is obtained when creating a bulk enrichment job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company Workforce

**Slug:** `COMPANYENRICH_GET_COMPANY_WORKFORCE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | CompanyEnrich company ID. Provide either `id` or `domain`. |
| `domain` | string | No | Company domain. Provide either `id` or `domain`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Country by Code

**Slug:** `COMPANYENRICH_GET_COUNTRY_BY_CODE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `country_code` | string | Yes | The ISO 3166-1 alpha-2 country code (e.g., US, GB, DE, FR). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `COMPANYENRICH_GET_CURRENT_USER`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Job Details

**Slug:** `COMPANYENRICH_GET_JOB_DETAILS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The unique identifier of the job to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get People Search Export Job Status

**Slug:** `COMPANYENRICH_GET_PEOPLE_SEARCH_EXPORT_JOB_STATUS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_id` | string | Yes | The unique identifier (UUID) of the person search export job to check the status of. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Regions

**Slug:** `COMPANYENRICH_GET_REGIONS`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get search export job status

**Slug:** `COMPANYENRICH_GET_SEARCH_EXPORT_JOB_STATUS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `jobId` | string | Yes | The unique identifier (UUID) of the search export job. This is returned when you create an export job. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List all jobs

**Slug:** `COMPANYENRICH_LIST_ALL_JOBS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List bulk enrichment jobs

**Slug:** `COMPANYENRICH_LIST_BULK_ENRICHMENT_JOBS`

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)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number (default: 1). |
| `status` | string ("pending" | "processing" | "completing" | "completed" | "failed") | No | Filter jobs by status. |
| `pageSize` | integer | No | Number of items per page (default: 20, max: 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Industries

**Slug:** `COMPANYENRICH_LIST_INDUSTRIES`

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.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Person Search Export Jobs

**Slug:** `COMPANYENRICH_LIST_PEOPLE_SEARCH_EXPORT_JOBS`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default: 1). |
| `status` | string ("pending" | "processing" | "completing" | "completed" | "failed") | No | Status of the async export job. |
| `page_size` | integer | No | Number of items per page (default: 20, max: 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List search export jobs

**Slug:** `COMPANYENRICH_LIST_SEARCH_EXPORT_JOBS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number (default: 1). |
| `status` | string ("pending" | "processing" | "completing" | "completed" | "failed") | No | Filter jobs by status. |
| `pageSize` | integer | No | Number of items per page (default: 20, max: 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Person by Email

**Slug:** `COMPANYENRICH_LOOKUP_PERSON`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | The email address of the person to look up (e.g., 'sarah.chen@stripe.com') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search people with cursor pagination

**Slug:** `COMPANYENRICH_SCROLL_PEOPLE_SEARCH`

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.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search cities by name or country

**Slug:** `COMPANYENRICH_SEARCH_CITIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to retrieve. 1-indexed. |
| `query` | string | No | The city name to search for. Maximum 30 characters. |
| `country_codes` | array | No | Filter cities by country codes (ISO 2-letter codes). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search companies by criteria

**Slug:** `COMPANYENRICH_SEARCH_COMPANIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to return. Must be greater than 0 |
| `type` | array | No | The list of company types to filter by |
| `lists` | array | No | The list IDs to filter by |
| `query` | string | No | The search query to apply on the company name and domain |
| `cities` | array | No | The city IDs to filter by |
| `states` | array | No | The state IDs to filter by |
| `exclude` | object | No | Exclusion filters to apply on the companies. |
| `regions` | array | No | The region IDs to filter by |
| `require` | array | No | The features that must exist for the company |
| `revenue` | array | No | The list of revenue ranges to filter by |
| `category` | array | No | The list of company categories to filter by |
| `keywords` | array | No | The keywords to filter by |
| `countries` | array | No | The 2 letter country codes to filter by |
| `employees` | array | No | The list of employee counts to filter by |
| `page_size` | integer | No | The number of results to return in each page. Must be between 1 and 100 |
| `naics_code` | array | No | 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_year` | object | No | The range of years |
| `funding_year` | object | No | The range of years |
| `technologies` | array | No | The technologies to filter by |
| `funding_amount` | object | No | The funding amount range to filter by |
| `funding_rounds` | array | No | The funding rounds to filter by |
| `semantic_query` | string | No | The semantic search query to find companies with. More natural language version of the standard query. |
| `semantic_weight` | number | No | The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. |
| `workforce_growth` | object | No | Filter companies by workforce growth percentage over a selected period and department. |
| `category_operator` | string ("And" | "Or") | No | The operator to apply to the filters. Defaults to And. |
| `keywords_operator` | string ("And" | "Or") | No | The operator to apply to the filters. Defaults to And. |
| `technologies_operator` | string ("And" | "Or") | No | The operator to apply to the filters. Defaults to And. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Countries

**Slug:** `COMPANYENRICH_SEARCH_COUNTRIES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. 1-indexed. |
| `query` | string | No | Search query to filter countries by name. Maximum 30 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search People

**Slug:** `COMPANYENRICH_SEARCH_PEOPLE`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | Yes | The page number to return. Must be greater than 0 |
| `query` | string | No | The search query to apply on the company name and domain |
| `domains` | array | No | The domains to find people for. Up to 100 domains are allowed. |
| `pageSize` | integer | Yes | The number of results to return in each page. Must be between 1 and 100 |
| `countries` | array | No | The 2 letter country codes to filter by |
| `seniority` | array | No | The seniorities to filter by |
| `department` | array | No | The departments to filter by |
| `positionQuery` | array | No | The list of search queries to apply on the person's current job position/title |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search States

**Slug:** `COMPANYENRICH_SEARCH_STATES`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | The page number to retrieve (1-indexed). |
| `query` | string | No | The search query for state name (max 30 characters). |
| `country_codes` | array | No | List of country codes to filter states by (e.g., ['US', 'CA']). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |