Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

The node "Magnet Customer" integrates with the Magnet Customer API to manage and interact with various CRM-related resources such as customers, deals, leads, prospects, organizations, tasks, staff, pipelines, and custom fields. Specifically, for the Customer resource with the Search operation, it allows users to search for customer contacts based on a search string.

This node is beneficial in scenarios where you want to automate customer data retrieval from Magnet Customer CRM within workflows, such as:

  • Searching for customers by name or other identifiers to enrich data or trigger follow-up actions.
  • Automating lead qualification by searching existing customers before creating new entries.
  • Integrating customer search into multi-step automation flows involving marketing, sales, or support.

Example use case: You have a list of customer names and want to find matching customer records in Magnet Customer to update their details or check their status automatically.

Properties

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

Note: The properties Life Cycle and Source are hidden and set internally to fixed values relevant to the contact lifecycle and source attribution.

Output

The node outputs an array of JSON objects representing the customer records that match the search criteria. Each item in the output corresponds to one customer record returned by the Magnet Customer API.

The structure of each JSON object includes all relevant customer fields as provided by the API response. This typically includes identifiers, names, contact details, lifecycle status, and any custom fields associated with the customer.

No binary data output is produced by this operation.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires user to provide valid credentials via either an API token or OAuth2 authentication.
  • The node depends on proper configuration of these credentials within n8n.
  • Pagination parameters (page and limit) control the volume of data retrieved per request.

Troubleshooting

  • Common issues:

    • Providing a search string shorter than 3 characters may result in no results or an error.
    • Incorrect or expired API credentials will cause authentication failures.
    • Exceeding API rate limits may cause temporary blocking or errors.
    • Setting limit below 15 might not be accepted due to minimum value constraints.
  • Error messages:

    • Authentication errors: Check that the API token or OAuth2 credentials are correctly configured and valid.
    • Validation errors on input parameters: Ensure the search string meets the minimum length requirement and pagination parameters are valid.
    • Network or API errors: Verify network connectivity and API service status.

Links and References


If you need further details about other operations or resources, feel free to ask!

Discussion