Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Custom Field Block → Search

AI-generated

Overview

This node interacts with the Magnet Customer API to perform a search operation on Custom Field Blocks. It allows users to search for custom field blocks with optional pagination and limit on the number of results. This is useful for retrieving specific custom field blocks based on a search term, which can help in managing and organizing custom fields in a CRM or customer management system.

Use Case Examples

  1. Search for custom field blocks containing a specific keyword to find relevant blocks for data entry forms.
  2. Retrieve a limited number of custom field blocks for display or processing in an automation workflow.

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 in the response, with a minimum value of 15.
Search Term Optional search term to filter the custom field blocks by name or content.

Output

JSON

  • _id - Unique identifier of the custom field block.
  • name - Name of the custom field block.
  • fields - Array of fields contained within the custom field block.
  • createdAt - Timestamp when the custom field block was created.
  • updatedAt - Timestamp when the custom field block was last updated.

Dependencies

  • Magnet Customer API
  • API Token or OAuth2 credentials

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and have the necessary permissions to access custom field blocks.
  • If the search returns no results, verify the search term is correct and that there are matching custom field blocks in the system.
  • Pagination parameters (page and limit) should be set correctly to avoid missing data or excessive data retrieval.

Discussion