Intercom icon

Intercom

Consume Intercom API
Join our community

Actions10

Overview

This node interacts with the Intercom API to retrieve users (contacts) associated with a specific company. The "Company" resource and "Users" operation allow you to list all contacts linked to a company, either by the company's Intercom-defined ID or your own custom company ID. This is useful for automating workflows that need to fetch all users belonging to a particular organization in Intercom, such as syncing user lists, performing bulk updates, or analyzing company-user relationships.

Example scenarios:

  • Fetching all users of a client company for onboarding or offboarding processes.
  • Syncing company user lists between Intercom and another CRM or database.
  • Triggering follow-up actions for every user within a specific company.

Properties

Name Type Meaning
List By options Determines how to identify the company: by Intercom's internal ID ("ID") or your own company ID ("Company ID").
Value string The actual value corresponding to the selected "List By" option (either the ID or company ID). Required.
Return All boolean Whether to return all results (true) or limit the number of returned users (false).
Limit number Maximum number of users to return if "Return All" is false. Must be at least 1.

Output

The output is an array of JSON objects, each representing a user (contact) associated with the specified company. Each object contains user details as provided by the Intercom API. Typical fields may include:

{
  "type": "contact",
  "id": "123456789",
  "workspace_id": "abcdefg",
  "external_id": null,
  "role": "user",
  "email": "user@example.com",
  "name": "John Doe",
  // ...other contact fields
}
  • If multiple users are found, the output will be an array of such objects.
  • If no users are found, the output will be an empty array.

Note: The exact structure depends on the Intercom API response for contacts.

Dependencies

  • External Service: Requires access to the Intercom API.
  • Credentials: You must configure intercomCredentialsApi in n8n with valid Intercom API credentials (such as a personal access token).
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common Issues:

  • Invalid Company ID/ID: If the provided company identifier does not exist, the node will return an error or an empty result.
  • Missing Credentials: If Intercom credentials are not set up correctly, authentication errors will occur.
  • API Rate Limits: Excessive requests may trigger Intercom API rate limiting, resulting in errors or delayed responses.

Error Messages:

  • "Intercom Error: {...}": Indicates an error from the Intercom API, such as invalid parameters or authentication failure. Check the error message for details.
  • "Cannot read property 'contacts' of undefined": May occur if the company ID is incorrect or the company has no users. Double-check the input values.

How to resolve:

  • Ensure the correct company identifier is used.
  • Verify that Intercom credentials are properly configured in n8n.
  • If hitting rate limits, reduce request frequency or implement retries.

Links and References

Discussion