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 operation, Fetch companies in list (POST), allows users to retrieve company data from a specified list using complex query conditions. It is designed for scenarios where you want to segment or filter companies within a predefined list based on various attributes such as industry, location, revenue, technologies used, and more.

Typical use cases include:

  • Marketing teams targeting specific business types or industries.
  • Sales teams filtering companies by size, location, or financial metrics.
  • Data analysts extracting subsets of companies matching certain criteria for further analysis.

For example, you could fetch all companies in a list that have more than 100 employees, are located in a specific country, and have a high monthly visitor count.

Properties

Name Meaning
Query A collection of rules defining the segmentation condition. Each rule includes:
- Attribute: The company attribute to filter by (e.g., "About > business type", "Finances > revenue").
- Blocked operator: Boolean flag.
- Operator: Logical operator to combine rules ("And" / "Or").
- Sign: Comparison sign ("Equals", "Exact equals", "Greater", "Lower", "Not equals").
- Values: One or multiple values to compare against.
Simplified Boolean flag indicating whether to return simplified company data.
Page Number specifying which page of results to fetch (pagination). Default is 1.
Size Number specifying how many companies to return per page. Default is 25.
Sort key Attribute by which to sort the results (e.g., "meta.score", "about.name", "finances.revenue").
Sort order Order of sorting: ascending ("asc") or descending ("desc"). Default is descending.
Sort fields Additional fields to sort by, provided as an array of strings.
List ID Numeric identifier of the list from which to fetch companies. This is required to specify the target list.
Action ID Numeric identifier for an action related to this request (optional).

Output

The output is a JSON array where each item corresponds to a company matching the query conditions. Each company's data structure contains detailed information depending on the requested fields and whether the simplified option is set:

  • Company attributes such as name, industry, employee count, year founded, domain, social profiles, technologies, finances, locations, and analytics.
  • Metadata like score and synchronization timestamp.
  • If simplified is true, the response contains a reduced set of company details for easier consumption.

No binary data output is produced by this operation.

Dependencies

  • Requires an API token credential for authentication with The Companies API service.
  • Uses the official SDK client of The Companies API to perform requests.
  • The node expects proper configuration of the API token in n8n credentials.

Troubleshooting

  • Unknown operation error: If the operation parameter is incorrect or missing, the node will throw an error stating "Unknown operation". Ensure the operation is set exactly to "fetchCompaniesInListPost".
  • Missing or invalid List ID: The listId property must be provided and valid; otherwise, the API may reject the request or return no results.
  • Invalid query rules: Improperly formatted query rules or unsupported attribute names can cause errors or empty responses. Validate the query structure carefully.
  • API token issues: Authentication failures due to missing or invalid API tokens will prevent the node from executing successfully. Verify the API token credential setup.
  • Pagination limits: Requesting pages beyond available data will result in empty outputs. Adjust page and size accordingly.

Links and References

Discussion