Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

The node integrates with the Magnet Customer API to perform various operations on different resources, including Leads. Specifically, for the Lead resource and the Search operation, it allows users to search for leads based on a text query. This is useful in scenarios where you want to find specific lead records matching certain criteria, such as part of a name or other identifying information.

Practical examples include:

  • Searching for leads by partial names or keywords to quickly filter relevant contacts.
  • Implementing automated workflows that retrieve lead details based on user input or external triggers.
  • Integrating lead search functionality into broader CRM automation pipelines.

Properties

Name Meaning
Authentication Method of authentication to use: "API Token" or "OAuth2".
Search The search string to look for in leads. Must be at least 3 characters long.
Page The page number of results to return (for pagination).
Limit Maximum number of results to return (minimum 15).
Life Cycle Hidden property indicating the life cycle stage of the contact; preset to "lead".
Source Hidden property indicating the source of the contact; preset to "n8n".

Note: The properties Life Cycle and Source are hidden and preset internally to ensure correct filtering and source attribution.

Output

The output is a JSON array containing the lead records that match the search criteria. Each item in the output corresponds to a lead object returned from the Magnet Customer API. The structure includes all standard lead fields as defined by the API.

If the node supports binary data output for this operation, it is not indicated in the provided code or properties, so the output is purely JSON-based.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires an API key credential or OAuth2 authentication configured in n8n.
  • The node uses internal helper functions to make authenticated requests to the API endpoints.

Troubleshooting

  • Common issues:

    • Providing a search string shorter than 3 characters may result in no results or errors.
    • Incorrect or missing authentication credentials will cause authentication failures.
    • Pagination parameters (page and limit) must be valid numbers; invalid values might cause unexpected behavior.
  • Error messages:

    • Errors from the API (e.g., unauthorized, bad request) will be thrown and can be caught if "Continue On Fail" is enabled.
    • If the node throws an error about missing or invalid parameters, verify that the required fields like search are correctly set.

Links and References


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

Discussion