Actions104
- Custom Field Actions
- Custom Field Block Actions
- Custom Field Type Actions
- Customer Actions
- Deal Actions
- Lead Actions
- Meeting Actions
- Meeting Room Actions
- Meeting Type Actions
- Organization Actions
- Pipeline Actions
- Prospect Actions
- Staff Actions
- Task Actions
- Ticket Actions
- Treatment Actions
- Treatment Type Actions
- Workspace Actions
Custom Field → Search
AI-generatedOverview
This node operation allows searching for custom fields within the Magnet Customer API. It supports filtering by various criteria such as feature type (contact, deal, organization, staff), contact lifecycle stage (contact, lead, prospect), and boolean filters for empty emails, phones, or interactions. It also supports pagination and sorting of results. This operation is useful for retrieving specific custom fields based on search terms and filters, which can be used in CRM or customer management workflows to dynamically access or manipulate custom field data.
Use Case Examples
- Search for custom fields related to contacts that have no phone numbers.
- Retrieve custom fields for deals sorted by creation date in descending order.
- Filter custom fields by feature type 'organization' and lifecycle stage 'lead'.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use (API Token or OAuth2). |
| Search Term | Optional search term to filter custom fields by name or content. |
| Filters | Collection of filters to narrow down the search results by feature type, lifecycle stage, and whether emails, phones, or interactions are empty. |
| Page | Page number for paginated results. |
| Limit | Maximum number of results to return, minimum 15. |
| Sort | Sorting options for the results, including field to sort by and sort direction. |
Output
JSON
_id- Unique identifier of the custom field.name- Name of the custom field.feature- Feature type the custom field belongs to (contact, deal, organization, staff).creatableWhen- Contact lifecycle stage when the custom field is creatable (contact, lead, prospect).emailsEmpty- Indicates if the emails field is empty for the custom field.phonesEmpty- Indicates if the phones field is empty for the custom field.interactionsEmpty- Indicates if the interactions field is empty for the custom field.page- Page number of the results returned.limit- Limit on the number of results returned.sortsortBy- Field used to sort the results.sortType- Sort direction used for sorting the results.
Dependencies
- Magnet Customer API
- API Token or OAuth2 credentials
Troubleshooting
- Ensure correct authentication method is selected and credentials are valid.
- Verify that the search term and filters are correctly formatted and supported by the API.
- Check API rate limits and handle pagination properly to avoid incomplete results.
- If custom fields are not resolving correctly, verify the 'resolveCustomFields' option and API response structure.