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 create a new company list based on specified segmentation criteria. It allows users to define complex queries using multiple rules that filter companies by attributes such as industry, location, technologies, and more. This is useful for marketing, sales, or analytics teams who want to build targeted company lists dynamically.
Practical examples include:
- Creating a list of companies in a specific industry with revenue greater than a certain amount.
- Building a dynamic list of companies headquartered in particular countries.
- Generating segmented lists for email campaigns with customized mail frequency settings.
Properties
| Name | Meaning |
|---|---|
| Query | A collection of rules defining conditions for the segmentation engine. Each rule includes: Attribute (e.g., industry, domain), Blocked operator (boolean), Operator (And/Or), Sign (Equals, Greater, etc.), and Values (one or more strings). |
| Dynamic | Boolean flag indicating if the list should be dynamic (automatically updated) or static. |
| Imported | Boolean flag indicating if the list was imported. |
| Mail frequency | Frequency of mailing updates related to this list. Options: Disabled, Daily, Weekly, Monthly. |
| Max companies | Maximum number of companies allowed in the list. |
| Name | Name of the list to be created. |
| Process initialized | Boolean flag indicating if processing has been initialized for the list. |
| Similar domains | List of domain strings considered similar for the purpose of the list. |
Output
The node outputs JSON data representing the newly created list. The structure typically contains details about the list such as its ID, name, query parameters, and metadata returned from The Companies API. If an error occurs, the output JSON will contain an error field with the error message.
No binary data output is produced by this node.
Dependencies
- Requires an API token credential for authenticating requests to The Companies API.
- Uses the official SDK from The Companies API (
@thecompaniesapi/sdk) to perform the create list operation. - No additional environment variables are required beyond the API token credential.
Troubleshooting
- Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an "Unknown operation" error. Ensure the operation is set to "createList".
- SDK method not found: If the SDK does not have the expected method, it throws an error. This may indicate version mismatch or misconfiguration.
- Invalid query rules: Improperly formatted or incomplete query rules can cause API errors. Verify that each rule has required fields: attribute, operator, sign, and values.
- API authentication failure: If the API token is invalid or missing, requests will fail. Confirm the API token credential is correctly configured.
- Empty or null property values: The node cleans empty or null properties before sending the request. However, ensure required properties like
nameandqueryare provided.
Links and References
- The Companies API Documentation
- The Companies API SDK on npm
- n8n Documentation on Creating Custom Nodes