The Companies API icon

The Companies API

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

Overview

This node integrates with The Companies API to search for companies based on various criteria. It allows users to build complex queries using multiple attributes and operators, filter results, sort them, and paginate through the data. This is useful in scenarios such as market research, lead generation, competitive analysis, or enriching CRM data with detailed company information.

For example, a user might search for companies in a specific industry with a minimum number of employees, exclude certain domains, and sort results by relevance score. The node returns structured company data matching the search criteria.

Properties

Name Meaning
Query A collection of rules defining conditions for filtering companies. Each rule includes: Attribute (e.g., business type, industries, domain), Blocked operator (boolean), Operator (And/Or), Sign (Equals, Greater, etc.), and Values.
Search A free-text search string to query companies.
Search fields List of fields to apply the free-text search on.
Domains to exclude Domains that should be excluded from the search results.
Linkedin to exclude LinkedIn IDs to exclude from the search results.
Simplified Boolean flag to return simplified company data.
Page Page number for paginated results (default 1).
Size Number of results per page (default 25).
Sort key Field by which to sort the results (e.g., meta.score, about.name, finances.revenue).
Sort order Order of sorting: Ascending or Descending.
Sort fields Additional fields to sort by.
Action ID Numeric identifier for an action related to the search (optional).

Output

The node outputs JSON data containing the search results from The Companies API. The structure typically includes an array of company objects with detailed attributes such as business type, industry, location, financials, social profiles, technologies used, and metadata like scores and sync timestamps.

If the "simplified" option is enabled, the output contains a reduced set of company information.

No binary data output is indicated.

Dependencies

  • Requires an API token credential for authenticating with The Companies API.
  • Uses the official SDK of The Companies API (@thecompaniesapi/sdk).
  • The node expects proper configuration of this API token within n8n credentials.

Troubleshooting

  • Unknown operation error: If the operation parameter is invalid or not recognized, the node throws an error indicating "Unknown operation". Ensure the operation name is correct and supported.
  • SDK method not found: If the SDK does not have the expected method for the operation, an error "SDK method ... not found" will occur. This may indicate version mismatch or incorrect operation selection.
  • Empty or invalid query parameters: If required query parameters are missing or empty, the node uses default values where defined. However, malformed inputs can cause errors or unexpected results.
  • API authentication failures: Ensure the API token credential is valid and has necessary permissions.
  • Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error details in the output JSON.

Links and References

Discussion