The Companies API icon

The Companies API

Access company data, enrichment, analytics and more using The Companies API
Join our community

Actions41

Overview

This node integrates with The Companies API to perform various "Actions" related to company data enrichment, segmentation, and list management. Specifically, the Request action operation allows users to send a complex query or job request to the platform's segmentation engine or other processing jobs such as enriching companies, cleaning up lists, or asking domain-related questions.

Typical use cases include:

  • Segmenting companies based on detailed attribute filters (e.g., industry, location, revenue).
  • Requesting enrichment jobs to append additional data to company records.
  • Asking specific questions about domains or lists.
  • Managing and cleaning company lists by requesting background processing jobs.

For example, a marketing team could use this node to segment companies in their CRM by industry and employee count, then trigger an enrichment job to fetch updated financial data for those companies.

Properties

Name Meaning
Query A collection of rules defining conditions for segmentation queries. Each rule includes: Attribute (e.g., industry, domain, revenue), Blocked operator (boolean), Operator (And/Or), Sign (Equals, Greater, etc.), and Values.
Domains List of domain names to include in the request.
Estimate Boolean flag indicating whether to estimate results without executing the full job.
Fields List of fields to be returned or considered in the response.
Job Type of job to request. Options: Ask-domain, Ask-list, Enrich-companies, Enrich-list, Cleanup-list.
Names List of company or entity names relevant to the request.
Question A textual question to ask the system, typically used with Ask-domain or Ask-list jobs.
Type Type of action request. Options: Jobs:request, Companies:added.
List ID Numeric identifier of a list to operate on or reference.
Prompt ID Numeric identifier of a prompt associated with the request.

Output

The node outputs JSON data representing the result of the requested action. The structure depends on the specific job and query parameters but generally includes:

  • data: The main payload returned from the API call, which may contain segmented company lists, enrichment results, answers to questions, or job status.
  • In case of errors, the output JSON contains an error field with the error message.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API token credential for authenticating with The Companies API.
  • Uses the official SDK client for The Companies API.
  • No additional environment variables are explicitly required beyond the API token.

Troubleshooting

  • Unknown operation error: If the operation parameter is incorrect or unsupported, the node throws an error stating "Unknown operation". Ensure the operation name is exactly "requestAction" for this resource.
  • SDK method not found: If the SDK does not have the expected method, it will throw an error. This usually indicates a mismatch between the SDK version and the node implementation.
  • Invalid or missing parameters: The node attempts to fill default values for some parameters; however, missing required parameters like query rules or job type can cause API errors.
  • API authentication failures: Ensure the provided API token credential is valid and has sufficient permissions.
  • Empty or malformed query rules: The query property must be properly structured with valid attributes and operators; otherwise, the API may reject the request.

Links and References

Note: This summary is based solely on static analysis of the provided source code and property definitions. Runtime behavior and dynamic responses depend on actual API responses and user input.

Discussion