Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

This node integrates with the Magnet Customer API to retrieve multiple custom field types. The "Get Many" operation under the "Custom Field Type" resource fetches a list of available custom field types defined in the Magnet Customer system.

This is useful when you want to dynamically obtain metadata about custom fields that can be used elsewhere in your workflows, such as mapping data or building dynamic forms. For example, you might use this node to get all custom field types and then loop through them to create records or update fields in other systems based on their type and name.

Properties

Name Meaning
Authentication Method of authentication to use: either "API Token" or "OAuth2".
Page The page number of results to retrieve (pagination). Defaults to 1.
Limit Maximum number of results to return per request. Minimum value is 1, default is 15.
Filters Collection of filters to narrow down results. Options include:
- Emails Empty (boolean): Filter where emails are empty.
- Phones Empty (boolean): Filter where phones are empty.
- Interactions Empty (boolean): Filter where interactions are empty.
Sort Collection specifying sorting options:
- Sort By (string): Field to sort by, default is "name".
- Sort Type (options): Sort direction, either "Ascending" or "Descending", default "asc".

Note: Some hidden properties related to "Life Cycle" and "Source" exist but are not relevant for this operation as they are hidden and fixed internally.

Output

The output is an array of JSON objects representing custom field types retrieved from the Magnet Customer API. Each object typically contains:

  • _id: Unique identifier of the custom field type.
  • name: The name of the custom field type.
  • fieldType: The type/category of the custom field (e.g., text, number, date).
  • Other metadata fields describing the custom field type.

The node returns these objects in the json property of each output item.

No binary data is output by this operation.

Dependencies

  • Requires access to the Magnet Customer API.
  • Requires user to provide valid credentials via either an API token or OAuth2 authentication.
  • The node uses internal helper functions to make authenticated HTTP requests to the Magnet Customer API endpoints.
  • Pagination and filtering parameters are supported to control the volume and subset of data returned.

Troubleshooting

  • Authentication errors: If the node fails due to invalid credentials, verify that the API token or OAuth2 credentials are correctly configured and have sufficient permissions.
  • Empty results: If no custom field types are returned, check if filters are too restrictive or if the account actually has custom field types defined.
  • Rate limits or API errors: The Magnet Customer API may impose rate limits; if errors occur, consider adding retry logic or reducing request frequency.
  • Invalid parameter values: Ensure that pagination parameters like page and limit are positive integers.

Links and References


If you need details on other operations or resources, feel free to ask!

Discussion