Actions41
- Companies Actions
- Search companies
- Search companies (POST)
- Enrich company
- Search companies by name
- Search companies by prompt
- Search similar companies
- Count companies
- Count companies (POST)
- Enrich company by email
- Enrich company by social
- Get email patterns
- Ask company
- Get company context
- Fetch companies analytics
- Export companies analytics
- Lists Actions
- Locations Actions
- Business data Actions
- Actions Actions
- Prompts Actions
- Utilities Actions
Overview
This node integrates with The Companies API to search for companies based on a user-provided prompt. It allows users to perform advanced company searches by specifying various parameters such as exclusion lists, pagination, sorting options, and similarity thresholds. This is useful in scenarios like market research, lead generation, competitive analysis, or enriching CRM data with detailed company information.
For example, a user can input a descriptive prompt about the type of companies they want to find (e.g., "tech startups in San Francisco with less than 50 employees") and receive a list of matching companies sorted by relevance or other criteria.
Properties
| Name | Meaning |
|---|---|
| Prompt | The search query string describing the companies to find. |
| Lists to exclude | Comma-separated identifiers of company lists to exclude from the search results. |
| Simplified | Boolean flag to return simplified company data instead of full details. |
| Page | The page number of the paginated results to retrieve (default is 1). |
| Size | Number of results per page (default is 25). |
| Sort key | Field by which to sort the results. Options include: About > business type, industries, name, total employees, year founded; Analytics > monthly visitors; Apps; Codes (naics, sic); Contacts; Domain; Finances; Locations; Meta score; Socials; Technologies; Urls. Default is meta.score. |
| Sort order | Order of sorting: ascending (asc) or descending (desc). Default is descending. |
| Similarity | A numeric threshold (0 to 1) indicating how similar the results should be to the prompt. Default is 0.6. |
| Sort fields | Additional fields to sort by, specified as an array of strings. |
Output
The node outputs JSON data containing the search results from The Companies API. Each item in the output corresponds to a company matching the search criteria, including detailed company information depending on whether the "Simplified" option was set.
- The
jsonfield contains the company data returned by the API. - If an error occurs during execution for a particular input item, the output will contain an
errorfield with the error message. - The node does not output binary data.
Dependencies
- Requires an API token credential for authenticating with The Companies API.
- Uses the official SDK of The Companies API (
@thecompaniesapi/sdk) bundled within the node. - No additional environment variables are required beyond the API token.
Troubleshooting
- Unknown operation error: If the operation parameter is set incorrectly or to an unsupported value, the node throws an error stating "Unknown operation". Ensure the operation is set to "searchCompaniesByPrompt".
- SDK method not found: If the SDK method corresponding to the operation is missing, the node throws an error. This indicates a mismatch between the operation name and the SDK version.
- Empty or invalid parameters: Parameters that are empty strings, zero, or null are replaced with default values internally. However, providing invalid types or malformed inputs may cause errors.
- API authentication errors: If the API token is invalid or missing, the node will fail to authenticate. Verify the API token credential configuration.
- Rate limiting or network issues: As with any external API, network failures or rate limits may cause errors. Implement retry logic or handle failures gracefully using the node's "Continue On Fail" option.