Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

The "Pipeline - Get Many" operation in this node allows users to retrieve multiple pipeline records from the Magnet Customer API. This is useful for scenarios where you want to list, filter, or sort pipelines within your CRM or sales process management system. For example, you might use this operation to fetch all active sales pipelines to display in a dashboard or to analyze pipeline stages and progress.

Practical examples include:

  • Fetching all pipelines to synchronize with another system.
  • Filtering pipelines based on whether they have associated emails, phones, or interactions.
  • Sorting pipelines by creation date or title to prioritize recent or specific pipelines.

Properties

Name Meaning
Authentication Method of authenticating with the API. Options: "API Token" or "OAuth2".
Return All Boolean flag indicating whether to return all pipeline results or limit the number returned.
Limit Maximum number of pipeline records to return when "Return All" is false. Minimum value is 1.
Filters Collection of filters to narrow down the pipelines returned:
• Search Term: Text to search for in pipelines.
• Has Emails?: Filter pipelines based on presence of emails (Any, Yes, No).
• Has Phones?: Same as emails but for phone numbers.
• Has Interactions?: Filter based on presence of interactions.
Sort Collection specifying sorting options:
• Sort By: Field to sort by (e.g., title, createdAt).
• Sort Direction: Ascending or Descending.

Note: Several hidden properties related to "Life Cycle" and "Source" exist but are not relevant for this operation as per the provided context.

Output

The output is an array of JSON objects representing pipeline records retrieved from the Magnet Customer API. Each object contains the pipeline's data fields such as ID, title, stages, creation date, and other metadata 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.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires either an API token or OAuth2 credentials configured in n8n for authentication.
  • The node internally uses helper functions to make HTTP requests to the API endpoints related to pipelines.

Troubleshooting

  • Authentication errors: Ensure that the API token or OAuth2 credentials are correctly set up and valid.
  • Empty results: Check filter criteria; overly restrictive filters may return no pipelines.
  • Limit ignored: If "Return All" is enabled, the "Limit" property is ignored.
  • API rate limits: If many requests are made, the API might throttle; consider adding delays or reducing request frequency.
  • Unexpected errors: The node captures errors per item and can continue execution if "Continue On Fail" is enabled, returning error messages in the output JSON.

Links and References

Discussion