Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

The "Get Many" operation for the "Prospect" resource in this node fetches multiple prospect records from the Magnet Customer API. This operation is useful when you want to retrieve a list of prospects, for example, to analyze potential customers, segment leads, or synchronize prospect data with other systems.

Typical use cases include:

  • Exporting all prospects for marketing campaigns.
  • Importing prospect lists into a CRM or sales tool.
  • Automating follow-ups by retrieving recent prospects added to the system.

Properties

Name Meaning
Authentication Method used to authenticate API requests. Options: "API Token", "OAuth2".
Life Cycle Hidden property indicating the life cycle stage of the contact; for this operation, it defaults to "prospect".
Source Hidden property indicating the source of the contact; defaults to "n8n".
Page The page number of results to retrieve (pagination).
Limit Maximum number of prospect records to return. Minimum value is 15.
Resolve Custom Fields When enabled, custom fields are returned with their actual names and option values instead of just IDs. Defaults to false.

Output

The output is an array of JSON objects representing prospect records retrieved from the API. Each object contains the data fields of a prospect, including standard properties and potentially custom fields.

If "Resolve Custom Fields" is enabled, custom field IDs are replaced with their corresponding names and option values, making the output more human-readable.

The node does not output binary data for this operation.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires authentication via either an API token or OAuth2 credentials configured in n8n.
  • Pagination support depends on the "page" and "limit" input properties.
  • Optional resolution of custom fields requires additional API calls internally to map IDs to names/values.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Setting a "limit" below 15 may result in errors or unexpected behavior due to API constraints.
    • If many custom fields exist and "Resolve Custom Fields" is enabled, the operation might be slower due to extra API requests.

  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; reconfigure credentials.
    • API rate limits may cause request failures; consider adding delays or reducing request frequency.
    • Pagination parameters out of range may cause empty results; verify "page" and "limit" values.

Links and References

Discussion