Intercom icon

Intercom

Consume Intercom API
Join our community

Actions10

Overview

The Intercom - Company: Get Many operation retrieves a list of companies from your Intercom account. This node is useful for automating workflows that require fetching company data, such as synchronizing company records with other systems, generating reports, or filtering companies based on specific criteria like segment or tag.

Practical examples:

  • Fetch all companies to update a CRM or ERP system.
  • Retrieve companies belonging to a specific segment or tagged with a certain label.
  • Limit the number of returned companies for batch processing or pagination.

Properties

Name Type Meaning
Return All Boolean Whether to return all results (true) or limit the number of results (false).
Limit Number The maximum number of companies to return. Only used if "Return All" is false.
Filters Collection Additional filters to narrow down the results. Includes Segment ID and Tag ID options.
  Segment ID String Filter companies by a specific segment.
  Tag ID String Filter companies by a specific tag.

Output

The output is an array of JSON objects, each representing a company. Each object typically contains fields such as:

{
  "type": "company",
  "id": "123456",
  "company_id": "acme-inc",
  "name": "Acme Inc.",
  "created_at": 1620000000,
  "updated_at": 1625000000,
  "remote_created_at": null,
  "last_request_at": null,
  "monthly_spend": 100,
  "session_count": 10,
  "user_count": 5,
  "size": 50,
  "website": "https://acme.com",
  "industry": "Software",
  "custom_attributes": {
    "plan": "Pro"
  },
  "tags": { ... },
  "segments": { ... }
}

Note: The actual structure may include additional fields depending on your Intercom setup and custom attributes.

Dependencies

  • External Service: Requires access to the Intercom API.
  • API Credentials: You must configure intercomCredentialsApi in n8n with your Intercom API key/token.

Troubleshooting

  • Common Issues:

    • Invalid credentials: Ensure your Intercom API credentials are correct and have sufficient permissions.
    • API rate limits: If you request too many items or make frequent requests, you may hit Intercom's API rate limits.
    • Empty results: Double-check your filter values (Segment ID, Tag ID) to ensure they match existing segments/tags in Intercom.

  • Error Messages:

    • "Intercom Error: {...}": Indicates an error response from the Intercom API. Check the message for details (e.g., invalid parameters, authentication issues).
    • "Cannot read property 'companies' of undefined": May occur if the API response format changes or is unexpected. Verify your filters and API status.

Links and References

Discussion