Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

This node integrates with the Magnet Customer API to perform various operations on different resources, including organizations. Specifically, for the Organization resource and the Search operation, it allows users to search for organizations based on a text query. This is useful in scenarios where you want to find organizations matching certain criteria or keywords within your CRM or customer management workflows.

Practical examples include:

  • Searching for an organization by name or partial name to retrieve its details.
  • Filtering organizations dynamically during automation to route data or trigger further actions.
  • Integrating with other systems to enrich or validate organization data based on search results.

Properties

Name Meaning
Authentication Method of authentication to use: "API Token" or "OAuth2".
Search The search string to look for in organizations. 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 value is 15.
Source Hidden property set to "n8n", indicating the source of the contact (not user-editable).
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 is a JSON array containing the search results from the Magnet Customer API for organizations matching the search query. Each item in the output corresponds to one organization record returned by the API.

The structure of each JSON object depends on the API response but typically includes organization details such as ID, full name, and other metadata.

No binary data output is produced by this node.

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:

    • Providing a search string shorter than 3 characters may result in no results or errors.
    • Pagination parameters (page and limit) must be valid numbers; invalid values might cause unexpected behavior.
    • Authentication failures if API token or OAuth2 credentials are incorrect or expired.

  • Error messages:

    • Errors from the API will be surfaced as error messages in the node output.
    • If the node is set to continue on fail, errors for individual items will be included in the output JSON under an error field.
    • To resolve authentication errors, verify that the API key or OAuth2 token is correctly configured and has necessary permissions.

Links and References

Discussion