---
canonical_url: "https://docs.composio.dev/toolkits/thecompaniesapi"
markdown_url: "https://docs.composio.dev/toolkits/thecompaniesapi.md"
product: "platform"
version: null
last_updated: null
---

# The Companies API

Search, enrich, and analyze company data, technologies, locations, lists, and related business intelligence.

- **Category:** company data
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `THECOMPANIESAPI`
- **Version:** 20261014_01
- **Instant:** Supported on the latest version. Support varies by tool.

## Tools

### Ask Company

**Slug:** `THECOMPANIESAPI_ASK_COMPANY`

Submit a natural-language question about a company and return either its immediate answer or the provider's pending-job details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string ("small" | "large") | No | Provider model size to use for the question. |
| `query` | array | No | Segmentation conditions to use as additional context. |
| `domain` | string | Yes | Exact company domain; schemes, ports, and URL paths are not accepted. |
| `fields` | array | No | Structured fields requested in the answer. |
| `explain` | boolean | No | Whether to include an explanation with the answer. |
| `list_id` | string | No | Provider list identifier to use as context. |
| `question` | string | Yes | Question to answer about the company. |

#### 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

**Slug:** `THECOMPANIESAPI_COUNT_COMPANIES`

Count companies matching text or structured segmentation filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | array | No | Structured company segmentation conditions. |
| `search` | string | No | Free-text company search value. |
| `action_id` | string | No | Provider action identifier included with the count request. |
| `search_fields` | array | No | Company fields searched by the free-text value. |

#### 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 With Body

**Slug:** `THECOMPANIESAPI_COUNT_COMPANIES_WITH_BODY`

Count companies using a JSON segmentation body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | array | No | Structured company segmentation conditions. |
| `search` | string | No | Free-text company search value. |
| `action_id` | string | No | Provider action identifier included with the count request. |
| `search_fields` | array | No | Company fields searched by the free-text value. |

#### 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 List

**Slug:** `THECOMPANIESAPI_CREATE_LIST`

Create an empty static company list with email notifications disabled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new static list. |

#### 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 |

### Delete List

**Slug:** `THECOMPANIESAPI_DELETE_LIST`

Permanently delete a company list by ID and return the deleted list record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | ID of the list to permanently delete. |

#### 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 Job Title

**Slug:** `THECOMPANIESAPI_ENRICH_JOB_TITLE`

Normalize a job title and infer its department and seniority classification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `job_title` | string | Yes | Job title to normalize, such as Software Engineer. |

#### 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 Account Context

**Slug:** `THECOMPANIESAPI_GET_ACCOUNT_CONTEXT`

Return the connected user, current team, subscription state, and remaining credit balance.

#### 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

**Slug:** `THECOMPANIESAPI_GET_COMPANY`

Return the cached company profile for an exact domain, optionally in a compact form; this tool does not force a paid refresh.

**Instant:** Supported on the latest version.

**Instant pricing:** Up to $0.001 per full company lookup; simplified lookup free

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact company domain; do not include a scheme, port, or URL path. |
| `simplified` | boolean | No | Return a compact profile when true; set false for all cached profile fields. This does not refresh company data. |

#### 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 by Email

**Slug:** `THECOMPANIESAPI_GET_COMPANY_BY_EMAIL`

Resolve an email address to company data and return parsed email validity details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address whose company and parsed email details should be returned. |
| `refresh` | boolean | No | Set true to ask the provider to refresh its company data before returning it. |
| `simplified` | boolean | No | Return a compact company profile when true; set false for all available profile fields. |

#### 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 by Social

**Slug:** `THECOMPANIESAPI_GET_COMPANY_BY_SOCIAL`

Resolve one or more company social profile URLs to a company profile.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `github` | string | No | Company GitHub profile URL. |
| `tiktok` | string | No | Company TikTok profile URL. |
| `refresh` | boolean | No | Set true to ask the provider to refresh its company data before returning it. |
| `twitter` | string | No | Company Twitter or X profile URL. |
| `youtube` | string | No | Company YouTube channel URL. |
| `dribbble` | string | No | Company Dribbble profile URL. |
| `facebook` | string | No | Company Facebook page URL. |
| `linkedin` | string | No | Company LinkedIn page URL. |
| `snapchat` | string | No | Company Snapchat profile URL. |
| `angellist` | string | No | Company AngelList profile URL. |
| `instagram` | string | No | Company Instagram profile URL. |
| `pinterest` | string | No | Company Pinterest profile URL. |
| `wellfound` | string | No | Company Wellfound profile URL. |
| `simplified` | boolean | No | Return a compact company profile when true; set false for all available profile fields. |
| `soundcloud` | string | No | Company SoundCloud profile URL. The provider receives its documented `souncloud` query key. |

#### 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 Context

**Slug:** `THECOMPANIESAPI_GET_COMPANY_CONTEXT`

Return categorized company facts and their source pages for an exact domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact company domain; schemes, ports, and URL paths are not accepted. |

#### 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 Email Patterns

**Slug:** `THECOMPANIESAPI_GET_COMPANY_EMAIL_PATTERNS`

Return known email-address patterns for an exact company domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact company domain; schemes, ports, and URL paths are not accepted. |
| `precision` | string | No | Minimum pattern precision from 0 through 100. |
| `emails_count` | boolean | No | Whether to include the number of known emails matching each pattern. |

#### 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 Companies In List

**Slug:** `THECOMPANIESAPI_LIST_COMPANIES_IN_LIST`

Return one page of companies currently contained in a specified company list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | ID of the company list to inspect. |
| `page_size` | integer | No | Maximum companies to return in this page. |
| `simplified` | boolean | No | Return compact company profiles when true. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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 Lists

**Slug:** `THECOMPANIESAPI_LIST_LISTS`

Return one page of company lists owned by the connected account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Maximum lists to return in this page. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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 |

### Rename List

**Slug:** `THECOMPANIESAPI_RENAME_LIST`

Rename an existing company list without changing its query, synchronization, or notification settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | New list name. |
| `list_id` | integer | Yes | ID of the list to rename. |

#### 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

**Slug:** `THECOMPANIESAPI_SEARCH_CITIES`

Search cities and return company counts and location identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Maximum cities to return in this page (1-20). |
| `search` | string | No | City name text to search for. |
| `filters` | string | No | Provider filter expression for narrowing cities. |
| `sort_key` | string | No | Field used to sort matching cities. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction for matching cities. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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

**Slug:** `THECOMPANIESAPI_SEARCH_COMPANIES`

Search the company database with text or structured segmentation conditions and return one page of matching company profiles.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per provider-reported search credit

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Free-text company name or domain search. |
| `page_size` | integer | No | Maximum companies to return in this page. |
| `conditions` | array | No | Structured filters combined in order; each condition needs attribute, operator, sign, and values. |
| `simplified` | boolean | No | Return compact company profiles when true; set false for all available profile fields. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `search_fields` | array | No | Fields used by free-text search; omit to use provider defaults. |
| `excluded_domains` | array | No | Company domains to omit from results. |
| `excluded_linkedin_urls` | array | No | LinkedIn company profile URLs to omit from results. |

#### 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 Name

**Slug:** `THECOMPANIESAPI_SEARCH_COMPANIES_BY_NAME`

Search companies by name and return one page of normalized profiles.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per provider-reported search credit

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Company name to search for. |
| `size` | string | No | Number of companies requested per page. |
| `sort_key` | string ("about.businessType" | "about.industries" | "about.industry" | "about.name" | "about.totalEmployees" | "about.yearFounded" | "analytics.monthlyVisitors" | "apps" | "codes.naics" | "codes.sic" | "contacts" | "domain.domain" | "domain.tld" | "finances.revenue" | "locations.headquarters.city.code" | "locations.headquarters.country.code" | "locations.headquarters.county.code" | "locations.headquarters.state.code" | "meta.score" | "meta.syncedAt" | "socials" | "technologies.active" | "urls") | No | Single company field used for sorting. |
| `countries` | string | No | Comma-separated country codes to include. |
| `simplified` | boolean | No | Whether to return simplified company profiles. |
| `sort_order` | string ("asc" | "desc") | No | Direction for sort_key. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. |
| `sort_fields` | array | No | Ordered company sort definitions. |
| `search_fields` | array | No | Company fields searched by name. |
| `lists_to_exclude` | string | No | Comma-separated company list IDs to exclude. |
| `exact_words_match` | boolean | No | Whether all words in the company name must match exactly. |

#### 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 Prompt

**Slug:** `THECOMPANIESAPI_SEARCH_COMPANIES_BY_PROMPT`

Search companies using a natural-language prompt and return one page.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per provider-reported search credit

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Number of companies requested per page. |
| `prompt` | string | Yes | Natural-language description of desired companies. |
| `sort_key` | string ("about.businessType" | "about.industries" | "about.industry" | "about.name" | "about.totalEmployees" | "about.yearFounded" | "analytics.monthlyVisitors" | "apps" | "codes.naics" | "codes.sic" | "contacts" | "domain.domain" | "domain.tld" | "finances.revenue" | "locations.headquarters.city.code" | "locations.headquarters.country.code" | "locations.headquarters.county.code" | "locations.headquarters.state.code" | "meta.score" | "meta.syncedAt" | "socials" | "technologies.active" | "urls") | No | Single company field used for sorting. |
| `similarity` | string | No | Provider similarity threshold from 0 through 2. |
| `simplified` | boolean | No | Whether to return simplified company profiles. |
| `sort_order` | string ("asc" | "desc") | No | Direction for sort_key. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. |
| `sort_fields` | array | No | Ordered company sort definitions. |
| `lists_to_exclude` | string | No | Comma-separated company list IDs to exclude. |

#### 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 With Body

**Slug:** `THECOMPANIESAPI_SEARCH_COMPANIES_WITH_BODY`

Search companies with a JSON segmentation body and return one page.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per provider-reported search credit

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Number of companies requested per page. |
| `query` | array | No | Structured company segmentation conditions. |
| `search` | string | No | Free-text company search value. |
| `sort_key` | string ("about.businessType" | "about.industries" | "about.industry" | "about.name" | "about.totalEmployees" | "about.yearFounded" | "analytics.monthlyVisitors" | "apps" | "codes.naics" | "codes.sic" | "contacts" | "domain.domain" | "domain.tld" | "finances.revenue" | "locations.headquarters.city.code" | "locations.headquarters.country.code" | "locations.headquarters.county.code" | "locations.headquarters.state.code" | "meta.score" | "meta.syncedAt" | "socials" | "technologies.active" | "urls") | No | Single company field used for sorting. |
| `action_id` | string | No | Provider action identifier included with the search. |
| `simplified` | boolean | No | Whether to return simplified company profiles. |
| `sort_order` | string ("asc" | "desc") | No | Direction for sort_key. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. |
| `sort_fields` | array | No | Ordered company sort definitions. |
| `search_fields` | array | No | Company fields searched by the free-text value. |
| `domains_to_exclude` | string | No | Comma-separated domains to exclude. |
| `linkedin_to_exclude` | string | No | Comma-separated LinkedIn company URLs to exclude. |

#### 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 Continents

**Slug:** `THECOMPANIESAPI_SEARCH_CONTINENTS`

Search continents and return company counts and location identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Maximum continents to return in this page (1-20). |
| `search` | string | No | Continent name text to search for. |
| `sort_key` | string | No | Field used to sort matching continents. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction for matching continents. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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 Counties

**Slug:** `THECOMPANIESAPI_SEARCH_COUNTIES`

Search counties and return company counts and location identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Maximum counties to return in this page (1-20). |
| `search` | string | No | County name text to search for. |
| `sort_key` | string | No | Field used to sort matching counties. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction for matching counties. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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:** `THECOMPANIESAPI_SEARCH_COUNTRIES`

Search countries and return company counts and location identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Maximum countries to return in this page (1-20). |
| `search` | string | No | Country name text to search for. |
| `filters` | string | No | Provider filter expression for narrowing countries. |
| `sort_key` | string | No | Field used to sort matching countries. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction for matching countries. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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 Industries

**Slug:** `THECOMPANIESAPI_SEARCH_INDUSTRIES`

Search industries and return one page of matching industry records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page number to retrieve. |
| `size` | string | No | Number of industries requested for this page, from 1 through 100. |
| `search` | string | No | Industry name text to search for. |
| `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |

#### 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 Similar Companies

**Slug:** `THECOMPANIESAPI_SEARCH_SIMILAR_COMPANIES`

Find companies similar to one or more source domains and return one page.

**Instant:** Supported on the latest version.

**Instant pricing:** $0.001 per provider-reported search credit

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Number of companies requested per page. |
| `domains` | array | Yes | Bare source domains; sent as repeated domains query parameters. |
| `sort_key` | string ("about.businessType" | "about.industries" | "about.industry" | "about.name" | "about.totalEmployees" | "about.yearFounded" | "analytics.monthlyVisitors" | "apps" | "codes.naics" | "codes.sic" | "contacts" | "domain.domain" | "domain.tld" | "finances.revenue" | "locations.headquarters.city.code" | "locations.headquarters.country.code" | "locations.headquarters.county.code" | "locations.headquarters.state.code" | "meta.score" | "meta.syncedAt" | "socials" | "technologies.active" | "urls") | No | Single company field used for sorting. |
| `simplified` | boolean | No | Whether to return simplified company profiles. |
| `sort_order` | string ("asc" | "desc") | No | Direction for sort_key. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous response. |
| `sort_fields` | array | No | Ordered company sort definitions. |
| `proximity_term` | string ("close" | "far" | "near") | No | Named proximity band requested from the provider. |
| `proximity_exact` | string | No | Exact numeric proximity requested from the provider. |

#### 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 Similar Industries

**Slug:** `THECOMPANIESAPI_SEARCH_SIMILAR_INDUSTRIES`

Find industries similar to one or more supplied industries and return one page of matches.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page number to retrieve. |
| `size` | string | No | Number of similar industries requested for this page, from 1 through 100. |
| `industries` | array | Yes | Industry names or slugs used to find similar industries. Each value is sent as a repeated industries query parameter. |
| `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |

#### 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:** `THECOMPANIESAPI_SEARCH_STATES`

Search states and return company counts and location identifiers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | string | No | Maximum states to return in this page (1-20). |
| `search` | string | No | State name text to search for. |
| `sort_key` | string | No | Field used to sort matching states. |
| `sort_order` | string ("asc" | "desc") | No | Sort direction for matching states. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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 Taxonomy

**Slug:** `THECOMPANIESAPI_SEARCH_TAXONOMY`

Search provider taxonomy values for industries, technologies, or geographic levels and return normalized identifiers for company filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Name fragment to match; omit to browse the selected taxonomy. |
| `taxonomy` | string ("industry" | "technology" | "city" | "county" | "country" | "state" | "continent") | No | Taxonomy collection to search. Required for the first page; omit when using next_cursor. |
| `page_size` | integer | No | Maximum taxonomy entries requested for this page. Industry results may be clamped to at least 10 by the provider. |
| `next_cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### 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 Technologies

**Slug:** `THECOMPANIESAPI_SEARCH_TECHNOLOGIES`

Search technologies and return one page of matching records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | string | No | Provider page number to retrieve. |
| `size` | string | No | Number of technologies requested for this page, from 1 through 100. |
| `search` | string | No | Technology name text to search for. |
| `next_cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. |

#### 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 |