Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

This node integrates with the Magnet Customer API, allowing users to interact with various resources such as customers, deals, tasks, organizations, leads, prospects, staff, pipelines, custom fields, and workspaces. Specifically, for the Workspace - Get operation, it retrieves details of a specific workspace by its ID.

Common scenarios where this node is beneficial include:

  • Fetching detailed information about a particular workspace in your CRM or project management system.
  • Automating workflows that require workspace data retrieval for reporting or synchronization purposes.
  • Integrating workspace data into other systems or dashboards.

Example use case: Automatically retrieve workspace details when a new deal is created to enrich deal data with workspace context.

Properties

Name Meaning
Authentication Method of authentication to use with the API. Options: "API Token", "OAuth2".
Workspace ID The unique identifier of the workspace to retrieve. This is required for the Get operation.

Note: There are several hidden properties related to "Life Cycle" and "Source" in the provided JSON, but they appear unrelated to the Workspace resource and its Get operation, so they are not relevant here.

Output

The output of the node is a JSON object representing the workspace data retrieved from the Magnet Customer API. The structure typically includes all available fields describing the workspace, such as its ID, name, description, creation date, and any other metadata provided by the API.

If the node supports binary data output (not indicated for this operation), it would be summarized accordingly, but for the Workspace Get operation, only JSON data is returned.

Dependencies

  • Requires an active connection to the Magnet Customer API.
  • Supports two authentication methods: API Token or OAuth2. Users must configure appropriate credentials in n8n.
  • No additional environment variables are explicitly required beyond standard API credential setup.

Troubleshooting

  • Common issues:

    • Invalid or missing Workspace ID: The node requires a valid workspace ID; ensure this is correctly set.
    • Authentication errors: Verify that the API token or OAuth2 credentials are correctly configured and have sufficient permissions.
    • Network or API downtime: Check connectivity and Magnet Customer API status if requests fail.
  • Error messages:

    • Errors thrown by the API (e.g., 404 Not Found) usually indicate the workspace ID does not exist or is inaccessible.
    • Authentication failures will result in authorization errors; recheck credentials.
  • Resolution tips:

    • Double-check the workspace ID input for typos.
    • Confirm API credentials and their scopes.
    • Use the node's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

  • Magnet Customer API Documentation (general reference for API endpoints and data structures)
  • n8n documentation on Credentials for setting up API tokens and OAuth2
  • n8n community forums and support channels for troubleshooting integration issues

Discussion