Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

The node "Magnet Customer" integrates with the Magnet Customer API to perform various operations on multiple resources such as deals, customers, leads, prospects, organizations, tasks, staff, pipelines, and custom fields. Specifically for the Deal resource with the Search operation, this node allows users to search for deals based on a text query.

This is useful in scenarios where you want to find specific deals matching certain criteria or keywords within your CRM data managed by Magnet Customer. For example, you might want to retrieve all deals containing a particular client name or deal title to automate follow-ups or reporting.

Properties

Name Meaning
Authentication Method of authentication to use: either "API Token" or "OAuth2".
Search The search string to look for in deals. Must be at least 3 characters long.
Page The page number of results to return (pagination).
Limit Maximum number of results to return. Minimum value is 15.
Source Hidden property set to "n8n", indicating the source of the contact (internal usage).
Life Cycle Hidden property indicating the life cycle stage of the contact (e.g., lead, prospect).

Note: Some hidden properties like source and lifeCycle are preset internally and not exposed for user input.

Output

The output of the node is an array of JSON objects representing the deals found by the search query. Each object corresponds to a deal record returned from the Magnet Customer API.

  • The json field contains the deal data with all relevant fields as provided by the API.
  • If the node is configured to resolve custom fields, those fields will be returned with their actual names and values instead of just IDs.
  • The node does not output binary data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Search string too short: The search requires a minimum of 3 characters; shorter strings may cause errors or no results.
    • Authentication failure: Ensure that the API token or OAuth2 credentials are valid and have sufficient permissions.
    • Pagination parameters: Incorrect page or limit values may result in empty responses or unexpected results.
  • Error messages:

    • Errors from the API (e.g., invalid token, rate limits) will be thrown and can be caught if "Continue On Fail" is enabled.
    • If the node throws an error about missing parameters, verify that required fields like "Search" are properly set.

Links and References


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

Discussion