Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

The "Magnet Customer" node integrates with the Magnet Customer API to perform various operations on different resources such as customers, deals, leads, organizations, prospects, and tasks. Specifically, for the Prospect resource with the Search operation, this node allows users to search for prospect contacts based on a search string.

This node is beneficial in scenarios where you want to automate the retrieval of prospect information from your CRM system by searching for prospects matching certain criteria. For example, you could use it to find prospects whose names or other attributes match a given keyword, enabling workflows that enrich data, trigger follow-ups, or segment prospects dynamically.

Properties

Name Meaning
Authentication Method of authentication to use: either "API Token" or "OAuth2".
Search The search string to look for within prospects. Must be at least 3 characters long.
Life Cycle (Hidden) The life cycle stage of the contact; preset to "prospect" for this resource.
Source (Hidden) The source identifier of the contact; preset to "n8n" for this integration.

Note: Several hidden properties like lifeCycle and source are preset internally to ensure correct API behavior and do not require user input.

Output

The node outputs an array of JSON objects representing the prospects found by the search query. Each object corresponds to a prospect record returned by the Magnet Customer API.

  • The output JSON contains all relevant fields of the prospect as provided by the API.
  • If custom fields are present, they may be returned as IDs unless the option to resolve custom fields is enabled.
  • No binary data output is indicated for this operation.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires user credentials configured in n8n, either via an API token or OAuth2 authentication.
  • The node uses internal helper functions to make authenticated HTTP requests to the API endpoints.

Troubleshooting

  • Common issues:

    • Providing a search string shorter than 3 characters will likely cause the API to reject the request or return no results.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity issues can prevent successful API calls.
  • Error messages:

    • Errors from the API will be caught and returned as error messages in the node output if "Continue On Fail" is enabled.
    • Typical errors include authentication failures, invalid parameters, or rate limiting.
  • Resolutions:

    • Ensure the search string meets the minimum length requirement.
    • Verify that the API credentials are valid and have sufficient permissions.
    • Check network connectivity and API service status.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.

Discussion