Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

The "Deal - Get" operation in this node retrieves detailed information about a specific deal from the Magnet Customer API. This is useful when you want to fetch up-to-date data on a particular sales deal, such as its status, associated contacts, custom fields, and other metadata.

Common scenarios include:

  • Fetching deal details to display or process in workflows.
  • Integrating deal data into CRM dashboards or reports.
  • Automating follow-up actions based on deal status or attributes.

For example, you might use this node to get a deal by its ID and then update another system with the deal's current stage or value.

Properties

Name Meaning
Authentication Method of authentication to use: API Token or OAuth2.
Deal ID The unique identifier of the deal to retrieve. This is required to specify which deal to get.
Resolve Custom Fields When enabled, custom fields returned by the API are resolved to their actual names and values instead of just IDs. Defaults to false.

Note: Several hidden properties related to "Life Cycle" and "Source" exist but are not user-configurable for this operation.

Output

The output JSON contains the full details of the requested deal as returned by the Magnet Customer API. This includes standard deal fields (e.g., title, status, pipeline stage) and optionally resolved custom fields if the "Resolve Custom Fields" option is enabled.

If custom fields are not resolved, they appear as IDs only. If resolved, the output shows human-readable field names and option values.

The node does not output binary data.

Dependencies

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

Troubleshooting

  • Missing or invalid Deal ID: Ensure the "Deal ID" property is set correctly; otherwise, the API will return an error.
  • Authentication errors: Verify that the API token or OAuth2 credentials are valid and have sufficient permissions.
  • Custom fields not resolving: If "Resolve Custom Fields" is enabled but fields remain unresolved, check API permissions and whether the custom fields exist.
  • API rate limits or connectivity issues: Network problems or API throttling can cause failures; retry or check API status.

Error messages typically come from the API and will be surfaced in the node's output if "Continue On Fail" is enabled.

Links and References

Discussion