Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Custom Field → Get

AI-generated

Overview

This node interacts with the Magnet Customer API to retrieve data about custom fields. Specifically, when using the 'Custom Field' resource with the 'Get' operation, it fetches details of a specific custom field by its ID. This is useful for scenarios where you need to access metadata or configuration details of custom fields within the Magnet Customer system, such as for integration, reporting, or automation purposes.

Use Case Examples

  1. Retrieve a custom field's details by providing its ID to use in further workflow steps.
  2. Fetch custom field metadata to dynamically build forms or validate data before submission.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request (API Token or OAuth2).
Custom Field ID The unique identifier of the custom field to retrieve. This is required for the 'Get' operation on the 'Custom Field' resource.

Output

JSON

  • _id - The unique identifier of the custom field.
  • name - The name of the custom field.
  • type - The type of the custom field.
  • options - Options available for the custom field if it is of a selectable type.
  • createdAt - Timestamp when the custom field was created.
  • updatedAt - Timestamp when the custom field was last updated.

Dependencies

  • Requires connection to the Magnet Customer API using either an API token or OAuth2 credentials.

Troubleshooting

  • Ensure the Custom Field ID provided is valid and exists in the Magnet Customer system; otherwise, the API will return an error.
  • Authentication errors may occur if the API token or OAuth2 credentials are incorrect or expired; verify credentials are correctly configured.
  • Network or API endpoint issues can cause request failures; check connectivity and API status.

Links

Discussion