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

Tools

Slug: THECOMPANIESAPI_ASK_COMPANYSubmit a natural-language question about a company and return either its immediate answer or the provider’s pending-job details. This action is unavailable in managed execution.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_COUNT_COMPANIESCount companies matching text or structured segmentation filters.

Input Parameters

array
Structured company segmentation conditions.
Free-text company search value.
string
Provider action identifier included with the count request.
array
Company fields searched by the free-text value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_COUNT_COMPANIES_WITH_BODYCount companies using a JSON segmentation body.

Input Parameters

array
Structured company segmentation conditions.
string
Free-text company search value.
string
Provider action identifier included with the count request.
array
Company fields searched by the free-text value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_CREATE_LISTCreate an empty static company list with email notifications disabled. This action is unavailable for managed executions.

Input Parameters

string
required
Name for the new static list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_DELETE_LISTPermanently delete a company list by ID and return the deleted list record. This action is unavailable for managed executions.

Input Parameters

integer
required
ID of the list to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_ENRICH_JOB_TITLENormalize a job title and infer its department and seniority classification. This action is unavailable for managed executions.

Input Parameters

string
required
Job title to normalize, such as Software Engineer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_GET_ACCOUNT_CONTEXTReturn the connected user, current team, subscription state, and remaining credit balance. This action is unavailable in managed execution.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_GET_COMPANYReturn 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.002 per full company lookup; simplified lookup freeDiscount: 37

Input Parameters

string
required
Exact company domain; do not include a scheme, port, or URL path.
boolean
Return a compact profile when true; set false for all cached profile fields. This does not refresh company data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_GET_COMPANY_BY_EMAILResolve an email address to company data and return parsed email validity details.

Input Parameters

string
required
Email address whose company and parsed email details should be returned.
boolean
Set true to ask the provider to refresh its company data before returning it.
boolean
Return a compact company profile when true; set false for all available profile fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_GET_COMPANY_BY_SOCIALResolve one or more company social profile URLs to a company profile.

Input Parameters

string
Company GitHub profile URL.
string
Company TikTok profile URL.
boolean
Set true to ask the provider to refresh its company data before returning it.
string
Company Twitter or X profile URL.
string
Company YouTube channel URL.
string
Company Dribbble profile URL.
string
Company Facebook page URL.
string
Company LinkedIn page URL.
string
Company Snapchat profile URL.
string
Company AngelList profile URL.
string
Company Instagram profile URL.
string
Company Pinterest profile URL.
string
Company Wellfound profile URL.
boolean
Return a compact company profile when true; set false for all available profile fields.
string
Company SoundCloud profile URL. The provider receives its documented souncloud query key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_GET_COMPANY_CONTEXTReturn categorized company facts and their source pages for an exact domain.

Input Parameters

string
required
Exact company domain; schemes, ports, and URL paths are not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_GET_COMPANY_EMAIL_PATTERNSReturn known email-address patterns for an exact company domain.

Input Parameters

string
required
Exact company domain; schemes, ports, and URL paths are not accepted.
string
Minimum pattern precision from 0 through 100.
boolean
Whether to include the number of known emails matching each pattern.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_LIST_COMPANIES_IN_LISTReturn one page of companies in a specified company list. This action is unavailable in managed execution.

Input Parameters

integer
required
ID of the company list to inspect.
integer
Maximum companies to return in this page.
boolean
Return compact company profiles when true.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_LIST_LISTSReturn one page of company lists owned by the connected account. This action is unavailable for managed executions.

Input Parameters

integer
Maximum lists to return in this page.
string
Continuation cursor returned by a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_RENAME_LISTRename an existing company list by ID. This action is unavailable for managed executions.

Input Parameters

string
required
New list name.
integer
required
ID of the list to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_CITIESSearch cities and return company counts and location identifiers.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_COMPANIESSearch 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.002 per search creditDiscount: 37

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_COMPANIES_BY_NAMESearch companies by name and return one page of normalized profiles.Instant: Supported on the latest version.Instant pricing: $0.002 per search creditDiscount: 37

Input Parameters

string
required
Company name to search for.
string
Number of companies requested per page.
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")
Single company field used for sorting.
string
Comma-separated country codes to include.
boolean
Whether to return simplified company profiles.
string ("asc" | "desc")
Direction for sort_key.
string
Opaque continuation cursor from a previous response.
array
Ordered company sort definitions.
array
Company fields searched by name.
string
Comma-separated company list IDs to exclude.
boolean
Whether all words in the company name must match exactly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_COMPANIES_BY_PROMPTSearch companies using a natural-language prompt and return one page.Instant: Supported on the latest version.Instant pricing: $0.002 per search creditDiscount: 37

Input Parameters

string
Number of companies requested per page.
string
required
Natural-language description of desired companies.
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")
Single company field used for sorting.
string
Provider similarity threshold from 0 through 2.
boolean
Whether to return simplified company profiles.
string ("asc" | "desc")
Direction for sort_key.
string
Opaque continuation cursor from a previous response.
array
Ordered company sort definitions.
string
Comma-separated company list IDs to exclude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_COMPANIES_WITH_BODYSearch companies with a JSON segmentation body and return one page.Instant: Supported on the latest version.Instant pricing: $0.002 per search creditDiscount: 37

Input Parameters

string
Number of companies requested per page.
array
Structured company segmentation conditions.
string
Free-text company search value.
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")
Single company field used for sorting.
string
Provider action identifier included with the search.
boolean
Whether to return simplified company profiles.
string ("asc" | "desc")
Direction for sort_key.
string
Opaque continuation cursor from a previous response.
array
Ordered company sort definitions.
array
Company fields searched by the free-text value.
string
Comma-separated domains to exclude.
string
Comma-separated LinkedIn company URLs to exclude.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_CONTINENTSSearch continents and return company counts and location identifiers.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_COUNTIESSearch counties and return company counts and location identifiers.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_COUNTRIESSearch countries and return company counts and location identifiers.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_INDUSTRIESSearch industries and return one page of matching industry records.

Input Parameters

string
Provider page number to retrieve.
string
Number of industries requested for this page, from 1 through 100.
string
Industry name text to search for.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_SIMILAR_COMPANIESFind companies similar to one or more source domains and return one page.Instant: Supported on the latest version.Instant pricing: $0.002 per search creditDiscount: 37

Input Parameters

string
Number of companies requested per page.
array
required
Bare source domains; sent as repeated domains query parameters.
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")
Single company field used for sorting.
boolean
Whether to return simplified company profiles.
string ("asc" | "desc")
Direction for sort_key.
string
Opaque continuation cursor from a previous response.
array
Ordered company sort definitions.
string ("close" | "far" | "near")
Named proximity band requested from the provider.
string
Exact numeric proximity requested from the provider.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_SIMILAR_INDUSTRIESFind industries similar to one or more supplied industries and return one page of matches.

Input Parameters

string
Provider page number to retrieve.
string
Number of similar industries requested for this page, from 1 through 100.
array
required
Industry names or slugs used to find similar industries. Each value is sent as a repeated industries query parameter.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_STATESSearch states and return company counts and location identifiers.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_TAXONOMYSearch provider taxonomy values for industries, technologies, or geographic levels and return normalized identifiers for company filters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: THECOMPANIESAPI_SEARCH_TECHNOLOGIESSearch technologies and return one page of matching records.

Input Parameters

string
Provider page number to retrieve.
string
Number of technologies requested for this page, from 1 through 100.
string
Technology name text to search for.
string
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

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