Intercom icon

Intercom

Consume Intercom API
Join our community

Actions10

Overview

The Intercom Contact Search operation allows you to search for contacts (users or leads) in your Intercom account based on various filters and criteria. This node is useful when you need to find specific contacts matching certain attributes, such as email, external ID, or tags, and retrieve either all results or a limited number of matches.

Common scenarios:

  • Finding all contacts with a specific email address.
  • Retrieving contacts associated with a particular tag.
  • Filtering contacts by custom attributes for targeted workflows.

Practical example:
You could use this node to fetch all users who have a specific tag and then send them a follow-up message or add them to a marketing campaign.

Properties

Name Type Meaning
Return All Boolean Whether to return all matching contacts (true) or limit the number of results (false).
Limit Number The maximum number of contacts to return (only shown if "Return All" is false).
Filters Fixed Collection A set of filter conditions to apply. Each filter includes:
- Field: The contact attribute to filter by (ID, Email, External_id, Tag_id).
- Value: The value to match against.
- Operator: The comparison operator (e.g., =, !=, IN, NIN, <, >, ~, etc.).

Output

  • The output is an array of JSON objects, each representing a contact that matches the search criteria.
  • Each object contains the standard Intercom contact fields, such as:
    • id
    • email
    • name
    • phone
    • custom_attributes
    • ...and other fields returned by the Intercom API.

Example output:

[
  {
    "id": "12345",
    "email": "user@example.com",
    "name": "John Doe",
    "phone": "+1234567890",
    "custom_attributes": {
      "plan": "pro"
    },
    ...
  }
]
  • If an error occurs and "Continue On Fail" is enabled, the output will include an object with an error field containing the error message.

Dependencies

  • External Service: Requires access to the Intercom API.
  • API Key: You must configure valid Intercom credentials in n8n under the name intercomCredentialsApi.
  • n8n Configuration: No additional environment variables are required beyond the credential setup.

Troubleshooting

Common issues:

  • Invalid Credentials: If the Intercom API key is missing or incorrect, authentication errors will occur.
  • Incorrect Filter Syntax: Using unsupported operators or invalid field names in filters may result in API errors.
  • Rate Limiting: Excessive requests to the Intercom API may trigger rate limits.

Error messages:

  • "Intercom Error: {...}": Indicates an error response from the Intercom API. Check the error details for more information.
  • "Cannot read property 'attribute' of undefined": Likely caused by missing or malformed filter input.
  • "Missing required parameter": Ensure all mandatory properties (like filters or limit) are provided.

How to resolve:

  • Double-check your Intercom credentials in n8n.
  • Review the filter configuration for correct field names and operators.
  • Reduce request frequency if hitting rate limits.

Links and References

Discussion