Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Custom Field Type → Search

AI-generated

Overview

This node interacts with the Magnet Customer API to perform a search operation on Custom Field Types. It allows users to search for custom field types using a search term, apply filters, and control pagination and sorting of the results. This is useful for scenarios where you need to find specific custom field types within the Magnet Customer system, such as when managing or integrating custom data fields in customer records.

Use Case Examples

  1. Searching for custom field types that match a specific keyword to dynamically populate options in a form.
  2. Filtering custom field types based on certain criteria like empty emails or phones to clean up or audit data.
  3. Sorting and paginating through custom field types to efficiently manage large sets of custom fields.

Properties

Name Meaning
Authentication Method of authentication to use for the API request, either API Token or OAuth2.
Page The page number of results to retrieve, used for pagination.
Limit Maximum number of results to return per page, with a minimum value of 15.
Search Term The term to search for within custom field types.
Filters Optional filters to refine the search results, including whether emails, phones, or interactions are empty.
Sort Options to sort the search results by a specified field and direction.

Output

JSON

  • _id - Unique identifier of the custom field type.
  • name - Name of the custom field type.
  • fieldType - Type of the custom field (e.g., text, number, date).
  • createdAt - Timestamp when the custom field type was created.
  • updatedAt - Timestamp when the custom field type was last updated.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and have the necessary permissions to access custom field types.
  • Verify that the search term and filters are correctly formatted and valid according to the API specifications.
  • If the node returns empty results, check the pagination parameters (page and limit) and adjust them as needed.
  • In case of API rate limits or network issues, retry the operation after some time or check network connectivity.

Links

Discussion